From 6324cd4e3fd44960a4e6fc197804fb2b553e8530 Mon Sep 17 00:00:00 2001 From: daedalus <44623501+ComfortablyCoding@users.noreply.github.com> Date: Sun, 29 Oct 2023 19:28:12 -0400 Subject: [PATCH] docs: add changeset generate command and version bump type explanations (#20244) Co-authored-by: Pascal Jufer --- contributors.yml | 1 + docs/contributing/pull-request-process.md | 14 ++++++++++++++ docs/dictionary.txt | 4 +--- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/contributors.yml b/contributors.yml index f65a00630d..7968f919cf 100644 --- a/contributors.yml +++ b/contributors.yml @@ -87,3 +87,4 @@ - eyecatchup - kevincam3 - cyrilf +- ComfortablyCoding diff --git a/docs/contributing/pull-request-process.md b/docs/contributing/pull-request-process.md index a3027a80b6..238f9c56b6 100644 --- a/docs/contributing/pull-request-process.md +++ b/docs/contributing/pull-request-process.md @@ -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. diff --git a/docs/dictionary.txt b/docs/dictionary.txt index f241581c9d..fdc73d68ca 100644 --- a/docs/dictionary.txt +++ b/docs/dictionary.txt @@ -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