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

Suggestion to make the pull request template more "concise" #20573

Merged
merged 1 commit into from
Nov 16, 2022

Conversation

MaEtUgR
Copy link
Member

@MaEtUgR MaEtUgR commented Nov 8, 2022

Solved Problem

I see lots of newcomers straight ignoring the pull request template.
Many times the whole

Please use PX4 Discuss or Discord to align on pull requests if necessary. You can then open draft pull requests to get early feedback.

is still in and probably nothing was read.

Solution

I suggest keeping it short, no full text, the top part commented.

Context

image

@MaEtUgR MaEtUgR self-assigned this Nov 8, 2022
@MaEtUgR MaEtUgR changed the title PULL_REQUEST_TEMPLATE: suggestion to make it more "concise" Suggestion to make the pull request template more "concise" Nov 8, 2022
@mrpollo
Copy link
Contributor

mrpollo commented Nov 8, 2022

I like the changes, perhaps the biggest problem is policing the template is being used.

@MaEtUgR
Copy link
Member Author

MaEtUgR commented Nov 8, 2022

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.

@MaEtUgR
Copy link
Member Author

MaEtUgR commented Nov 14, 2022

Any feedback on this? I'm happy to iterate.

Copy link
Contributor

@junwoo091400 junwoo091400 left a 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.
-->
Copy link
Contributor

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)

@MaEtUgR
Copy link
Member Author

MaEtUgR commented Nov 16, 2022

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.

@MaEtUgR MaEtUgR merged commit fd4d4e0 into main Nov 16, 2022
@MaEtUgR MaEtUgR deleted the pull-request-template branch November 16, 2022 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants