-
Notifications
You must be signed in to change notification settings - Fork 13.3k
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
Suggestion to make the pull request template more "concise" #20573
Conversation
0673c75
to
f44f950
Compare
I like the changes, perhaps the biggest problem is policing the template is being used. |
@mrpollo I agree that in practice it's often better to stick to the template because that's simpler and most people try to save time writing the description. But in principle policing needs to just ensure good descriptions not following the template. The template should simplify creating a pull request description that's living up to expectations. A contributor can still use his own adapted equally useful structure and not follow the template. |
Any feedback on this? I'm happy to iterate. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general seems like a good change!! 🎉
|
||
## Describe possible alternatives | ||
A clear and concise description of alternative solutions or features you've considered. | ||
--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could add something like this: (anything that reminds users to upload the ULog!! As daniel said during the dev call.
If you have a log, make sure to upload it to https://review.px4.io/ (it accelerates review / feedback process)
I guess if there are no more opinions then I'll merge this, wait for further feedback and we can iterate e.g. on making log upload even more prominent. |
Solved Problem
I see lots of newcomers straight ignoring the pull request template.
Many times the whole
is still in and probably nothing was read.
Solution
I suggest keeping it short, no full text, the top part commented.
Context