docs: add changeset generate command and version bump type explanations (#20244)

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
This commit is contained in:
daedalus
2023-10-29 19:28:12 -04:00
committed by GitHub
parent 039608b5b1
commit 6324cd4e3f
3 changed files with 16 additions and 3 deletions

View File

@@ -87,3 +87,4 @@
- eyecatchup
- kevincam3
- cyrilf
- ComfortablyCoding

View File

@@ -43,3 +43,17 @@ To properly generate changelogs and determine the right version number after a c
[changesets](https://github.com/changesets/changesets). Each pull request should include a changeset that describes
whether the change is a patch/minor/major version bump, and describe what the change is. Changesets should be written in
past tense.
A changeset can be generated via the following command:
```shell
pnpm changeset
```
### Changeset Bump Definitions
The following are the types of version bumps that can be specified in a changeset:
- Major (x.0.0) - A change has been made that is incompatible with previous versions.
- Minor (0.x.0) - A feature has been added that is backwards compatible with previous versions.
- Patch (0.0.x) - A bug has been fixed that is backwards compatible with previous versions.

View File

@@ -13,6 +13,7 @@
Butterfield
(C|)ancelling
(C|c)ancelled
(C|c)hangesets?
(C|c)harset
(C|c)heckboxes
(C|c)loudinary
@@ -128,9 +129,6 @@ Cardgroup
cardinality
CDNs?
changelogs
changeset
changesets
Changesets
CLA
CLI
CloudFront