Skip to content

Commit 9106cc9

Browse files
authored
Docs: Clarify changelogs
1 parent 7db6b5a commit 9106cc9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/Maintenance.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,5 @@ Here’s a [good example of a change log](https://github.com/styleguidist/react-
8181
1. Generate a change log draft using [tamia-changelog](https://github.com/tamiadev/tamia-changelog): `npx tamia-changelog`
8282
2. Edit `Changelog.md` file.
8383
3. Commit the change log: `npx tamia-changelog commit`.
84+
85+
**Note:** do not commit the `Changelog.md` file, the release tool reads the changelog from the commit message. [Read how it works](https://blog.sapegin.me/all/semantic-release/).

0 commit comments

Comments
 (0)