Skip to content

docs(readme): Clarify what appears in the changelog #220

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

Merged
merged 1 commit into from
Apr 8, 2025
Merged

docs(readme): Clarify what appears in the changelog #220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 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,14 @@ 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.

### Why do my `refactor`, `chore` etc changes not appear in the changelog?

By default, the conventional commits preset is used. This means that only `fix`, `feat` and anything marked as a breaking change will appear in the changelog.

Conventional commits is meant to make it easy for machines to reason about the user-facing changes,
and the changelog generation makes it easy for humans to consume this information too.
Usually, you wouldn't want non-user facing changes like refactor in the changelog.

## License

ISC