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

Consider renaming CHANGELOG to CHANGELOG.md #127

Open
heynan0 opened this issue Sep 9, 2022 · 1 comment
Open

Consider renaming CHANGELOG to CHANGELOG.md #127

heynan0 opened this issue Sep 9, 2022 · 1 comment

Comments

@heynan0
Copy link

heynan0 commented Sep 9, 2022

Consider turning the plain text CHANGELOG into a markdown file.

That way, we can leverage linking to the pull requests that added new features or made other kinds of changes. Writing #123 will turn into a link where others can quickly reference when they are reading it and need to upgrade to a newer version. They will have confidence about the changes that are introduced and can check it won't break their application.

@brandur
Copy link
Owner

brandur commented Sep 11, 2022

This project was started long enough ago that the Markdown changelog wasn't a super common standard quite yet so I think I just left things as plaintext. I'm not against going to Markdown though — we'd just want to make sure to update references elsewhere to it and maybe leave a CHANGELOG file in place with a hint that changes are now located in CHANGELOG.md.

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