summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-03-24 12:43:05 +0100
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2022-03-24 13:06:15 +0100
commite1ad7f26415fe74585e3f65aceaf5852672d67d9 (patch)
tree6c8cbdf767772473d87a19fe84734b3fd673f757
parentec4a3f7f1eac9e605b35d1ac56680e1608c48be3 (diff)
downloadpylint-git-e1ad7f26415fe74585e3f65aceaf5852672d67d9.tar.gz
Upgrade documentation for contributors.txt
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md3
-rw-r--r--doc/development_guide/contribute.rst5
2 files changed, 4 insertions, 4 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 46b9eb71a..c1c6615b0 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,11 +3,12 @@ Thank you for submitting a PR to pylint!
To ease the process of reviewing your PR, do make sure to complete the following boxes.
-- [ ] Add yourself to ``CONTRIBUTORS.txt`` if you are a new contributor.
- [ ] Add a ChangeLog entry describing what your PR does.
- [ ] If it's a new feature, or an important bug fix, add a What's New entry in
`doc/whatsnew/<current release.rst>`.
- [ ] Write a good description on what the PR does.
+- [ ] If you used multiple emails or multiple names when contributing, add your mails
+ and preferred name in ``script/.contributors_aliases.json``
-->
## Type of Changes
diff --git a/doc/development_guide/contribute.rst b/doc/development_guide/contribute.rst
index aa975bb27..a15753240 100644
--- a/doc/development_guide/contribute.rst
+++ b/doc/development_guide/contribute.rst
@@ -87,7 +87,8 @@ of Pylint as it gives you access to the latest ``ast`` parser.
- Add a short entry in :file:`doc/whatsnew/VERSION.rst`.
-- Add yourself to the `CONTRIBUTORS.txt` file.
+- If you used multiple emails or multiple names when contributing, add your mails
+ and preferred name in the ``script/.contributors_aliases.json`` file.
- Write a comprehensive commit message
@@ -100,8 +101,6 @@ of Pylint as it gives you access to the latest ``ast`` parser.
- Send a pull request from GitHub (see `About pull requests`_ for more insight
about this topic)
-
-
.. _`Closing issues via commit messages`: https://help.github.com/articles/closing-issues-via-commit-messages/
.. _`About pull requests`: https://help.github.com/articles/using-pull-requests/
.. _tox: https://tox.readthedocs.io/en/latest/