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

Guidelines for changelog entries? #656

Open
Oberon00 opened this issue Jun 15, 2020 · 3 comments
Open

Guidelines for changelog entries? #656

Oberon00 opened this issue Jun 15, 2020 · 3 comments
Labels
area:miscellaneous For issues that don't match any other area label release:after-ga Not required before GA release, and not going to work on before GA

Comments

@Oberon00
Copy link
Member

Oberon00 commented Jun 15, 2020 •
edited
Loading

Currently we don't seem to have guidelines for changelog entries. If I just want to see the PRs that were merged I can go e.g. to v0.4.0...v0.5.0 and get an overview already. We should consider which advantage our manual changelogs should provide over the github-generated one. I would suggest creating changelog entries:

  • Only for changes that actually affect SIGs (i.e. not for formatting, etc)
  • Changelog entries should be actionable. That is, as a SIG maintainer, from reading it, I should know whether there is something to do for my SIG and where I can get details what to do (preferably without consulting git blame for the changelog).
@Oberon00
Copy link
Member Author

@arminru made the related suggestion to group the changelog entries by kind (new/changed/editorial), see #633 (review)

@carlosalberto
Copy link
Contributor

This is a good thing to have, yes, and agree with your suggestion. I also like @arminru suggestion, so we can apply them both IMO.

@carlosalberto carlosalberto added the question Question for discussion label Jun 26, 2020
@carlosalberto carlosalberto mentioned this issue Jul 1, 2020
Merged
@carlosalberto carlosalberto added area:miscellaneous For issues that don't match any other area label release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Jul 10, 2020
@carlosalberto carlosalberto added the priority:p2 Medium priority level label Jul 24, 2020
@tigrannajaryan
Copy link
Member

This would be a nice improvement, but I think it is not a must-have for GA. I suggest to remove release:required-for-ga label.

@Oberon00 Oberon00 added release:after-ga Not required before GA release, and not going to work on before GA and removed question Question for discussion release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Sep 9, 2020
@andrewhsu andrewhsu removed the priority:p2 Medium priority level label Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:miscellaneous For issues that don't match any other area label release:after-ga Not required before GA release, and not going to work on before GA
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@andrewhsu @carlosalberto @Oberon00 @tigrannajaryan