Skip to content

Commit 0da9aea

Browse files
authored
docs(readme): Clarify what appears in the changelog (#220)
Replaces #209 with a description instead of examples
1 parent e0019fd commit 0da9aea

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -629,6 +629,14 @@ with other package managers for other ecosystems).
629629

630630
When you are ready to release v1.0.0, add `--release-as 1.0.0` to the options.
631631

632+
### Why do my `refactor`, `chore` etc changes not appear in the changelog?
633+
634+
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.
635+
636+
Conventional commits is meant to make it easy for machines to reason about the user-facing changes,
637+
and the changelog generation makes it easy for humans to consume this information too.
638+
Usually, you wouldn't want non-user facing changes like refactor in the changelog.
639+
632640
## License
633641

634642
ISC

0 commit comments

Comments
 (0)