Releases: olivierlacan/keep-a-changelog
Releases · olivierlacan/keep-a-changelog
Remove empty sub-sections, differentiate between "CHANGELOG" and "change log"
Added
- Better explanation of the difference between the file ("CHANGELOG")
and its function "the change log".
Changed
- Refer to a "change log" instead of a "CHANGELOG" throughout the site
to differentiate between the file and the purpose of the file — the
logging of changes.
Removed
- Remove empty sections from CHANGELOG, they occupy too much space and
create too much noise in the file. People will have to assume that the
missing sections were intentionally left out because they contained no
notable changes.
"Why should I care?"
Added
- "Why should I care?" section mentioning The Changelog podcast.
Explain reverse chronological date ordering.
Added
- Explanation of the recommended reverse chronological release ordering.
Create initial CHANGELOG example.
Added
- This CHANGELOG file to hopefully serve as an evolving example of a standardized open source project CHANGELOG.
- CNAME file to enable GitHub Pages custom domain
- README now contains answers to common questions about CHANGELOGs
- Good examples and basic guidelines, including proper date formatting.
- Counter-examples: "What makes unicorns cry?"