Update PULL_REQUEST_TEMPLATE.md by thrau · Pull Request #8831 · localstack/localstack · GitHub
Skip to content
This repository was archived by the owner on Mar 23, 2026. It is now read-only.

Update PULL_REQUEST_TEMPLATE.md#8831

Merged
thrau merged 2 commits into
masterfrom
update-pr-template
Aug 7, 2023
Merged

Update PULL_REQUEST_TEMPLATE.md#8831
thrau merged 2 commits into
masterfrom
update-pr-template

Conversation

@thrau

@thrau thrau commented Aug 5, 2023

Copy link
Copy Markdown
Member

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 be 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

coveralls commented Aug 5, 2023

Copy link
Copy Markdown

@alexrashed alexrashed left a comment

Copy link
Copy Markdown
Member

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. 🚀

@viren-nadkarni viren-nadkarni left a comment

Copy link
Copy Markdown
Member

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!


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

@viren-nadkarni viren-nadkarni Aug 7, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change

Copy link
Copy Markdown
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
Copy Markdown
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 subscribe to this conversation on GitHub. Already have an account? Sign in.

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