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

Add and maintain a Changelog #82

Closed
Weibye opened this issue Jun 6, 2022 · 2 comments
Closed

Add and maintain a Changelog #82

Weibye opened this issue Jun 6, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Weibye
Copy link
Collaborator

Weibye commented Jun 6, 2022

What problem does this solve or what need does it fill?

Based on this comment but generally having a changelog help users quickly get a high-level overview of the project and how it compares to its forks

What solution would you like?

  • Create a Changelog.md in root and keep it up to date according to https://keepachangelog.com/en/1.0.0/
  • Add a note in PR-template that user should update changelog if relevant
  • All pull requests that contains a relevant change, should add single-line note of the change in the Changelog.md under the ## [Unreleased] section
  • When cutting a release:
    1. Replace the header ## [Unreleased] with the date and version of the release: ## [x.y.z] - YYYY-MM-DD
    2. Add a new ## [Unreleased] header near the top of the document

What alternative(s) have you considered?

Keep as is and don't keep a changelog.

@Weibye Weibye added enhancement New feature or request documentation Improvements or additions to documentation labels Jun 6, 2022
@alice-i-cecile
Copy link
Collaborator

This is done, as RELEASES.md :)

@Weibye
Copy link
Collaborator Author

Weibye commented Jun 6, 2022

Oh, right, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants