Code review suggestions
This commit is contained in:
parent
40d0ade2d9
commit
eea169e515
|
@ -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
|
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):
|
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 `master` branch for bug fixes, documentation updates and trivial changes.
|
||||||
- [ ] Target the `features` branch for new features and removals/deprecations.
|
- [ ] Target the `features` branch for new features and removals/deprecations.
|
||||||
- [ ] Include documentation when adding new features.
|
- [ ] Include documentation when adding new features.
|
||||||
|
|
|
@ -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.
|
* ``feature``: new user facing features, like new command-line options and new behavior.
|
||||||
* ``bugfix``: fixes a reported bug.
|
* ``bugfix``: fixes a reported bug.
|
||||||
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
|
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
|
||||||
* ``removal``: feature deprecation or removal;
|
* ``removal``: feature deprecation or removal.
|
||||||
* ``vendor``: vendoring news;
|
* ``vendor``: changes in packages vendored in pytest.
|
||||||
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
|
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
|
||||||
|
|
||||||
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
|
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
|
||||||
|
|
Loading…
Reference in New Issue