Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unreleased version link should use lower case #429

Open
jasongerbes opened this issue Mar 20, 2022 · 1 comment
Open

Unreleased version link should use lower case #429

jasongerbes opened this issue Mar 20, 2022 · 1 comment

Comments

@jasongerbes
Copy link

Hi there, just a minor issue I noticed on the Keep a Changelog website.

Currently the [unreleased] link in the Version 1.0.0 example uses title case:

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD

This should be lowercase (i.e. [unreleased]:...) as reference links are case-insensitive, and the current example conflicts with markdown formatters (e.g. Prettier).

Also worth noting that this repo's CHANGELOG.md also uses lowercase.

@olivierlacan olivierlacan changed the title Docs: Unreleased version link should use lower case Unreleased version link should use lower case Mar 8, 2023
@olivierlacan
Copy link
Owner

I'm a bit curious why Prettier would have an opinion here. This is an editorial choice, not something up to a linter.

[unreleased] would display lowercase heading, which is not the intent, even if that matches more clearly, Markdown reference links are not case-sensitive, so the reference link works fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants