Pull request template: add changelog entry #21425
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mrpollo
approved these changes
Apr 4, 2023
|
FYI, I decided to stop CI since we are low on runners, and this change doesn't affect the codebase (famous last words...) |
|
This pull request has been mentioned on Discussion Forum for PX4, Pixhawk, QGroundControl, MAVSDK, MAVLink. There might be relevant details there: https://discuss.px4.io/t/px4-maintainers-call-april-04-2023/31415/1 |
junwoo091400
added
the
Documentation 📑
|
I think we should give it a try. We can change if it turns out to not help. Let's enforce this before merging PRs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solved Problem
In the maintainer call of 04.04.2023 we discussed that it would help anyone doing release notes if the pull requests contain changelog entries that just need to be filtered and concatenated. E.g. @mrpollo and @tstastny know the pain of finding the all important changes and writing a concise description for them.
Solution
We could add a title and make sure there is a useful changelog entry for every pull request before merging it. For very small prs the description could consist of only the changelog entry to not convolute the description unnecessarily.
Alternatives
We could carry the changelog in tree but it would likely lead to many versioning conflicts.
We could also do further changes to the template to make it slimmer.