Revisit PR template [ci skip] #6104
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,19 @@ | ||
| Thanks for submitting a PR, your contribution is really appreciated! | ||
|
|
||
| Here is a quick checklist that should be present in PRs. | ||
|
|
||
| !! Please delete this text from the final description, this is just a guideline) !! | ||
|
|
||
| - [ ] Target the `master` branch for bug fixes, documentation updates and | ||
| trivial changes. But please use `features` for changes touching many | ||
|
Member
There was a problem hiding this comment. isn't the opposite slightly better (since we frequently merge master into features but rarely the other way)
Contributor
Author
There was a problem hiding this comment. The point here is that it should go to the leading branch, and not the stable/release branch (for bugfixes).
Contributor
Author
There was a problem hiding this comment. @asottile |
||
| files. | ||
| Target the `features` branch for new features, improvements, and | ||
| removals/deprecations. | ||
| - [ ] Include documentation when adding new features. | ||
| - [ ] Include new tests or update existing tests when applicable. | ||
|
|
||
| Unless your change is trivial or a small documentation fix (e.g., a typo or | ||
| reword of a small section) please: | ||
|
|
||
| - [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst) for details. | ||
| - [ ] Add yourself to `AUTHORS` in alphabetical order | ||
|
Member
There was a problem hiding this comment. Big +1 for removing this semicolon! It's not necessary here, you don't use them at the end of a sentence; they would only go in the middle of a sentence, a bit like a comma.
Contributor
Author
There was a problem hiding this comment. @hugovk |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
As per #6159 (comment) removing the comments might be good already.
Happy to create a PR, but please approve it here already, so that it does not get talked down again.
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.
I think the "(please delete...)" could be removed from here, but I'd leave the other instructions inside comments, otherwise you'll see them on many PRs.