Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): add example of commits that appear in the changelog #208

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(docs): add example of commits that appear in the changelog #208

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e67e30
fix(docs): add example of commits that appear in the changelog
asieduernest12 Dec 23, 2024
dd680b2
format
asieduernest12 Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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