From dc02cf4d23a1126c5d640720416a58b1e2109365 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Tue, 29 Oct 2019 20:02:27 +0100 Subject: [PATCH] Revisit PR template [ci skip] - make it clear that the text should be deleted, which is often not the case - resulting in handling it as incomplete TODOs - clarify targetting master/features and make it a single actionable item. Ref: https://github.com/pytest-dev/pytest/pull/6064#issuecomment-547568299 - fix punctuation --- .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f516959bc83..bd9acac9ce3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,19 @@ - -- [ ] Target the `master` branch for bug fixes, documentation updates and trivial changes. -- [ ] Target the `features` branch for new features, improvements, and removals/deprecations. +!! 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 + 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: +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 `..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; +- [ ] Add yourself to `AUTHORS` in alphabetical order