summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno Oliveira <nicoddemus@gmail.com>2018-02-08 08:03:14 -0200
committerBruno Oliveira <nicoddemus@gmail.com>2018-02-08 08:03:14 -0200
commiteea169e5151da473909fa8bcc467ac7d2380accd (patch)
tree87be570c2c23774e0c6dd4bff85bf90a183ed46f
parent40d0ade2d9d0ab6d8d8b3df759945511042f86b5 (diff)
downloadpytest-eea169e5151da473909fa8bcc467ac7d2380accd.tar.gz
Code review suggestions
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md2
-rw-r--r--changelog/README.rst4
2 files changed, 3 insertions, 3 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 64769b8e2..23a9f8c56 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@ Thanks for submitting a PR, your contribution is really appreciated!
Here's a quick checklist that should be present in PRs (you can delete this text from the final description, this is
just a guideline):
-- [ ] Create a new changelog file into the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](/changelog/README.rst) for details.
+- [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](/changelog/README.rst) for details.
- [ ] Target the `master` branch for bug fixes, documentation updates and trivial changes.
- [ ] Target the `features` branch for new features and removals/deprecations.
- [ ] Include documentation when adding new features.
diff --git a/changelog/README.rst b/changelog/README.rst
index ec1c7f617..f00720de9 100644
--- a/changelog/README.rst
+++ b/changelog/README.rst
@@ -12,8 +12,8 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
* ``feature``: new user facing features, like new command-line options and new behavior.
* ``bugfix``: fixes a reported bug.
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
-* ``removal``: feature deprecation or removal;
-* ``vendor``: vendoring news;
+* ``removal``: feature deprecation or removal.
+* ``vendor``: changes in packages vendored in pytest.
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
So for example: ``123.feature.rst``, ``456.bugfix.rst``.