Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update PULL_REQUEST_TEMPLATE.md #8831

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

Merged
merged 2 commits into from
Aug 7, 2023
Merged

Update PULL_REQUEST_TEMPLATE.md #8831

merged 2 commits into from
Aug 7, 2023

Conversation

thrau
Copy link
Member

@thrau thrau commented Aug 5, 2023

Motivation

It's been on the TODO list for a long time to create a PR template. The initial attempt in #6084 ended up becoming stale, mostly because the template was a little too involved. Moreover, the long list of check boxes in the template lead to all issues having something like "2 of 14 tasks" indicators in the overview, which is a bit misleading, since some of them are single choice lists so PRs will always appear as incomplete unless you delete the list of tasks.

The Motivation and Changes structure has found itself into many PRs by a number of Authors. Examples:

So it seems this could a good minimal standard structure!

Changes

  • Update the pull_request_template.md with a bare-bone template and some additional optional sections behind comments
  • Added very brief comments what to write into the section (keep it simple)
  • Added some additional optional sections (Testing and TODO, which I've found useful in the past)
  • Moved the hint about contribution guidelines into a comment to make sure we don't end up with more PRs that just have that in their description

@thrau thrau added the semver: patch Non-breaking changes which can be included in patch releases label Aug 5, 2023
@coveralls
Copy link

coveralls commented Aug 5, 2023

Coverage Status

coverage: 82.707% (-0.02%) from 82.722% when pulling 303dd79 on update-pr-template into 220c458 on master.

Copy link
Member

@alexrashed alexrashed left a comment

Choose a reason for hiding this comment

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

Nice! The structure is simple and has already proven useful. 🚀

Copy link
Member

@viren-nadkarni viren-nadkarni left a comment

Choose a reason for hiding this comment

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

Suggesting a 'Related' section. LGTM otherwise!


- [ ] ...
- [ ] ...

Copy link
Member

@viren-nadkarni viren-nadkarni Aug 7, 2023

Choose a reason for hiding this comment

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

Suggested change
## Related
Issues, PRs or external links that give more context to this PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

i would argue that these should go into the motivation section

Copy link
Member Author

Choose a reason for hiding this comment

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

added a comment 👍

@thrau thrau merged commit 9abed2b into master Aug 7, 2023
@thrau thrau deleted the update-pr-template branch August 7, 2023 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver: patch Non-breaking changes which can be included in patch releases
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants