-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Some changes to sections and references.
Including sections with no notables changes by putting a single "- Nothing." entry was a bad idea because for every single release this created a ton of noise. My only gripe with this decision is that users now have to assume that — for instance — the "Deprecated" section was intentionally left out because it contained nothing, while it's quite possible that they maintainers may not have deemed deprecations worthy of a change log entry. That's a problem because it makes expectations hard to manage. Another change I've made is that I now refer to a "change log" (lower case, two words) instead of a "CHANGELOG" (uppercase, one word) because I've released that the file is named "CHANGELOG" but the purpose of the file matters more than its name. Moreover the previous spelling made for awkward sentences and style.
- Loading branch information
1 parent
795bb2d
commit d63e825
Showing
2 changed files
with
27 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,30 @@ | ||
# Changelog | ||
# Change Log | ||
All notable changes to this project will be documented in this file. | ||
|
||
## 0.0.3 - 2014-08-09 | ||
|
||
### Added | ||
- "Why should I care?" section mentioning The Changelog podcast. | ||
|
||
### Deprecated | ||
- Nothing. | ||
## 0.0.4 - 2014-08-09 | ||
### 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 | ||
- Nothing. | ||
- 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. | ||
|
||
### Fixed | ||
- Nothing. | ||
## 0.0.3 - 2014-08-09 | ||
### Added | ||
- "Why should I care?" section mentioning The Changelog podcast. | ||
|
||
## 0.0.2 - 2014-07-10 | ||
|
||
### Added | ||
- Explanation of the recommended reverse chronological release ordering. | ||
|
||
### Deprecated | ||
- Nothing. | ||
|
||
### Removed | ||
- Nothing. | ||
|
||
### Fixed | ||
- Nothing. | ||
|
||
|
||
## 0.0.1 - 2014-05-31 | ||
|
||
### 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?" | ||
|
||
### Deprecated | ||
- Nothing. | ||
|
||
### Removed | ||
- Nothing. | ||
|
||
### Fixed | ||
- Nothing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters