tyler.durden/keep-a-changelog
1
0
Fork 0
mirror of https://github.com/olivierlacan/keep-a-changelog.git synced 2025-07-30 01:04:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove confusing section about casing

Browse Source 
We just say “changelog” now and we can scrap this mess.
This commit is contained in:
Olivier Lacan 2017-04-27 12:09:24 -07:00
parent 5347b92dba
commit 2e4f7351e8
1 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/en/0.4.0/index.html.haml
View File

@ -123,20 +123,6 @@ version: 0.4.0
created by the [Gemnasium][gemnasium] team and which parses
many (but not all) open source project changelogs.
### Why do you alternate between spelling it "CHANGELOG" and "changelog"?
"CHANGELOG" is the name of the file itself. It's a bit shouty but it's a
historical convention followed by many open source projects. Other
examples of similar files include [`README`][README], [`LICENSE`][LICENSE],
and [`CONTRIBUTING`][CONTRIBUTING].
The uppercase naming (which in old operating systems made these files stick
to the top) is used to draw attention to them. Since they're important
metadata about the project, they could be useful to anyone intending to use
or contribute to it, much like [open source project badges][shields].
When I refer to a "changelog", I'm talking about the function of this
file: to log changes.
### What about yanked releases?
Yanked releases are versions that had to be pulled because of a serious
bug or security issue. Often these versions don't even appear in change