Why do you write about Changelog?

CHANGELOG (update log) is a time-in-reverse list that records all significant changes in the project. It is read by humans, not machines. Many developers wrongly directly export Git Commit records, but this is often full of "fixes" Information that is meaningless to users, such as bugs and “updates”.

♪ That's a pain ♪ ♪ One user doesn't know what the new version is updated ♪

Solutions: Follow Keep a Changelog Normative. Changes are grouped into six main categories: Added (new functionality), Fixed (repairing loopholes), Changed (functional improvements). So users can see at first glance what they care about, for example: "Fixed: solved the problem of the collapse of the page below iOS." This tool guides you through visual interfaces to complete this classification and to ensure the high readability of the log.

♪ Painful 2: version's out of order, the cost of upgrading is unpredictable ♪

Solutions: Complement SemVer 。 Quite clearly inform users through CHANGELOG that this is a patched version (only Fixed), a minor version (with Added) But it's also a major version (with Removed or Breaking Changes). Clear logs can significantly reduce the risk of integration by downstream developers and enhance the professionalism and user trust of the project.

Okay, what should Changelog have?

Easy to read. : In Markdown format, hierarchy.
Group by Version : The latest version always ranks ahead of the top.
Organisation : specify the time of publication of each version.
Avoid bullshit. : Do not include minor changes that would be meaningful only for internal development.

How to use this tool?

Click on " New Version " , enter the version number and date.
Select the type of change (e.g. Fixed), enter the description, click to add.
Real time preview of the right generated Markdown.
Click Download, rename it as CHANGELOG.md Put it in your root list.