From 5e67e301edbfba3a30548292b8e528e6b7154ad0 Mon Sep 17 00:00:00 2001 From: ERNEST ASARE-ASIEDU Date: Mon, 23 Dec 2024 03:35:08 -0500 Subject: [PATCH 1/2] fix(docs): add example of commits that appear in the changelog --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 6275c852a..fa5169aff 100644 --- a/README.md +++ b/README.md @@ -629,6 +629,25 @@ with other package managers for other ecosystems). When you are ready to release v1.0.0, add `--release-as 1.0.0` to the options. + +### Commit examples that show up in CHANGELOG + +##### Supported commits 👍 +feat(someScope)!: this is included, case insensitive 👍 +fix: this will be included, case insensitive 👍 +Fix: this will be included, case insensitive 👍 +fix(someScope): this is included, case insensitive 👍 +feat: this will be included, case insensitive 👍 +feat(someScope): this is included, case insensitive 👍 +Feat(someScope): this is included, case insensitive 👍 +feAt(someScope): this is included, case insensitive 👍 + +##### Unsupported commits ❌ +update: excluded ❌ +anythingNotFeatOrFixOrBREAKING CHANGE: excluded ❌ +update/someScope: excluded ❌ +ci: excluded ❌ + ## License ISC From dd680b2e066198a403dd74252a37b6446df3c198 Mon Sep 17 00:00:00 2001 From: ERNEST ASARE-ASIEDU Date: Mon, 23 Dec 2024 03:39:31 -0500 Subject: [PATCH 2/2] format --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fa5169aff..16eb08293 100644 --- a/README.md +++ b/README.md @@ -633,20 +633,20 @@ When you are ready to release v1.0.0, add `--release-as 1.0.0` to the options. ### Commit examples that show up in CHANGELOG ##### Supported commits 👍 -feat(someScope)!: this is included, case insensitive 👍 -fix: this will be included, case insensitive 👍 -Fix: this will be included, case insensitive 👍 -fix(someScope): this is included, case insensitive 👍 -feat: this will be included, case insensitive 👍 -feat(someScope): this is included, case insensitive 👍 -Feat(someScope): this is included, case insensitive 👍 -feAt(someScope): this is included, case insensitive 👍 + - feat(someScope)!: this is included, case insensitive 👍 + - fix: this will be included, case insensitive 👍 + - Fix: this will be included, case insensitive 👍 + - fix(someScope): this is included, case insensitive 👍 + - feat: this will be included, case insensitive 👍 + - feat(someScope): this is included, case insensitive 👍 + - Feat(someScope): this is included, case insensitive 👍 + - feAt(someScope): this is included, case insensitive 👍 ##### Unsupported commits ❌ -update: excluded ❌ -anythingNotFeatOrFixOrBREAKING CHANGE: excluded ❌ -update/someScope: excluded ❌ -ci: excluded ❌ + - update: excluded ❌ + - anythingNotFeatOrFixOrBREAKING CHANGE: excluded ❌ + - update/someScope: excluded ❌ + - ci: excluded ❌ ## License