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.

Sign up for GitHub

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

Jump to bottom

Keep a changelog in the repo #1380

Open
tfr42 opened this issue Sep 6, 2022 · 2 comments
Open

Keep a changelog in the repo #1380

tfr42 opened this issue Sep 6, 2022 · 2 comments
Labels
contributions welcome asking for contribution (time and money sponsor) TMC discussion to be discussed by technical management committee members

Comments

@tfr42
Copy link
Member

tfr42 commented Sep 6, 2022

Besides the generated change logs per release a changelog file in mark down shall be kept in the repo.

https://keepachangelog.com/en/1.0.0/
@tfr42 tfr42 added TMC discussion to be discussed by technical management committee members contributions welcome asking for contribution (time and money sponsor) labels Sep 6, 2022
@tfr42
Copy link
Member Author

tfr42 commented Sep 7, 2022

The TMC would like to have such change log but would like to avoid any additional manual labor to maintain it.

@stephanr
Copy link
Member

stephanr commented Sep 7, 2022

In addition it would also be nice to have explicit links in README.md and/or the Website to point to the actual Releases page on github.
It may would also make sense to create a separate CHANGELOG.md that also references the github relases page as well.

@tfr42 tfr42 mentioned this issue Sep 14, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
contributions welcome asking for contribution (time and money sponsor) TMC discussion to be discussed by technical management committee members
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tfr42 @stephanr