Make Changelog more prominent/a website

[rugk]

Background

I came from flathunters/flathunter#636 and I wanted to find out the difference from v1.4 to v2.0… so I clicked on the linked website in the footer. I then saw there is even 2.1 and this just sparked my curiosity.
I clicked through the website, FAQ, "latest version" (which sounded as if maybe Im could also find a link to an older version there) etc. but I could not find anything.

I later only found #744 by chance by searching the issues there and with the PR #800 there I also found the file, finally:

https://github.com/EthicalSource/contributor_covenant/blob/6dceaf3c5d560b2367ad49f127c4516e90c9b251/changelog

Anyway, call me stupid fir not finding a file at the root of the repo, but it really does not look "good" TBH/IMHO and I am sorry, but I see several problems with it…

Problems

• the file has literally a lowercase only file name and no file extension – it just does not stand out like how README.md or LICENSE.md do…
• why no file extension at all, it should be .txt at least?
• that said, the formatting is not really user-friendly, at least Markdown would be better
• the ordering is bad IMHO, having the oldest version first implies for the lastest changes I need to read from the bottom-up – as this is a usual use case quite inconvenient
• the version numbers do not explain/contain the date of publication
• IMHO it could also need some expansion or short explanation of why a chance was made, not only what. Maybe also by linking to previous discussions/GitHub PRs or whatever, but that may help to more easily clarify things…

Suggestion

Make the changelog more prominent. I'd say:

• make it a header or so at the website
• list it there and remove it from the repo(?)

Alternative solutions

• keep it in the repo, but improve it there (like the MD etc.)
• maybe groom https://github.com/EthicalSource/contributor_covenant/releases a bit more, the changelog feature used there also does not seem to have all the entries etc.? (Could also be done additionally…)

[Chealer]

Naming the changelog changelog (fully lowercase) is not unusual. It's in fact Debian's convention, however there are several other conventions.

In any case, you are right that this contrasts with other files in this repository and effectively makes it harder to find than one would expect. I myself looked for it for a minute and "gave up" assuming there was none. Renaming to CHANGES may be good, but for sure adding a link from the homepage's (poorly named) Contributor Covenant v2.1 section would help much.

And yes, you are quite right about the dates and chronological order. Thanks for reporting