This repository has been archived by the owner on Jul 24, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
Changelog Guidelines
Oren Kanner edited this page Jul 2, 2014
·
2 revisions
-
Fabric has a great changelog here that pulls info from their version control system. This is great! (via blog post)
- It looks like he has turned this into an open-source tool for generating HTML changelogs: releases, we should investigate!
- Node.js has a more basic changelog
- GitHub for Windows has really nice release notes, I like the terminology that they use (added, fixed, improved)... we might consider using this for user-facing release notes as opposed to the dev-facing changelog though.
- I think we should definitely link to the GitHub issue for each bug fix or feature request in the Changelog so people can review the development process.
- We should separate changes into bugs, features, and enhancements (I think they call them "support" in Fabric above), either by labeling each entry or separating them into sections
- Any major changes (e.g. a Ruby version change) should be noted before anything else.