Skip to content

Commit 282cf74

Browse files
committed
add contributing section
1 parent 2f518ab commit 282cf74

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Diff for: README.md

+18
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
TODO
44

5+
## Contributing
6+
7+
### Document Your Changes
8+
9+
**Changeset Documentation**
10+
11+
Before committing your changes, document them with a changeset. This process helps in tracking modifications and effectively communicating them to the project team and users:
12+
13+
```bash
14+
pnpm changeset
15+
```
16+
17+
During the changeset creation process, you will be prompted to select the appropriate level for your changes:
18+
19+
- **patch**: Opt for this if you are making small fixes or minor changes that do not affect the library's overall functionality.
20+
- **minor**: Choose this for new features that enhance functionality but do not disrupt existing features.
21+
- **major**: Select this for any changes that result in backward-incompatible modifications to the library.
22+
523
## Release a new version
624

725
On your local machine run the following command:

0 commit comments

Comments
 (0)