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

Add pull request template #4161

Closed

Conversation

poliorcetics
Copy link
Contributor

Adding a Pull Request template will make it easier for new and repeat contributors to learn and
remember common tasks to do when creating a PR and for reviewers to know what the PR is about with
a quick look.

Closes #4002

@kirawi kirawi added the S-waiting-on-review Status: Awaiting review from a maintainer. label Oct 9, 2022
Copy link
Contributor

@SoraTenshi SoraTenshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My 2 cents :)


## Tasks (not applicable to all PRs)

If something is unneeded, just don't check it, if it was needed, either the CI or a reviewer will
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If something is unneeded, just don't check it, if it was needed, either the CI or a reviewer will
If something is not required, just don't check it, if it was required, either the CI or a reviewer will

i believe that required sounds a bit better in this context :)


## Questions

<!--- Do you have points you're not sure about ? Add them here --->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!--- Do you have points you're not sure about ? Add them here --->
<!--- Do you have points you're not sure about? Add them here --->

@the-mikedavis
Copy link
Member

I was in favor of a template but I've used them at work for a while now and now I'm not sure I really like them: they add a lot of boilerplate that obscures the actual description.

I think it might be ok though to have a PR template that only includes an HTML comment that gives some pointers like cargo xtask docgen. But the github UI brings up the CONTRIBUTING doc for new contributions so it might be better just to clean up and expand that documentation

@poliorcetics poliorcetics deleted the 4002-pr-template branch April 25, 2023 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from a maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a PR template to help improve ease of reviewing
4 participants