From 32f7d0e97cd7ca6941f296a6628041e9b9cc1c90 Mon Sep 17 00:00:00 2001 From: Timothy Jones Date: Tue, 8 Apr 2025 16:55:13 -0700 Subject: [PATCH] docs(readme): Clarify what appears in the changelog Replaces #209 with a description instead of examples --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 6275c852a..85a850241 100644 --- a/README.md +++ b/README.md @@ -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