Skip to content

Commit 0502be5

Browse files
Links in the documentation to help triaging and labelling the backlog (#7179)
In order to easily be able to do maintenance task Closes #7101 Co-authored-by: Daniël van Noord <[email protected]>
1 parent 65543fd commit 0502be5

File tree

2 files changed

+50
-4
lines changed

2 files changed

+50
-4
lines changed

doc/development_guide/contributor_guide/contribute.rst

+48-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,57 @@
1-
.. -*- coding: utf-8 -*-
2-
31
==============
42
Contributing
53
==============
64

75
.. _repository:
86

7+
Finding something to do
8+
-----------------------
9+
10+
Want to contribute to pylint? There's a lot of things you can do.
11+
Here's a list of links you can check depending on what you want to do:
12+
13+
- `Asking a question on discord`_, or `on github`_
14+
- `Opening an issue`_
15+
- `Making the documentation better`_
16+
- `Making the error message better`_
17+
- `Reproducing bugs and confirming that issues are valid`_
18+
- `Investigating or debugging complicated issues`_
19+
- `Designing or specifying a solution`_
20+
- `Giving your opinion on ongoing discussion`_
21+
- `Fixing false positives or bugs`_
22+
- `Creating new features or fixing false negatives`_
23+
- `Reviewing pull requests`_
24+
25+
.. _`Asking a question on discord`: https://discord.com/invite/qYxpadCgkx
26+
.. _`on github`: https://github.com/PyCQA/pylint/issues/new/choose
27+
.. _`Opening an issue`: https://github.com/PyCQA/pylint/issues/new?assignees=&labels=Needs+triage+%3Ainbox_tray%3A&template=BUG-REPORT.yml
28+
.. _`Making the documentation better`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Documentation+%3Agreen_book%3A%22
29+
.. _`Making the error message better`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+project%3Apycqa%2Fpylint%2F4+
30+
.. _`Reproducing bugs and confirming that issues are valid`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+reproduction+%3Amag%3A%22%2C%22Cannot+reproduce+%F0%9F%A4%B7%22
31+
.. _`Investigating or debugging complicated issues`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+investigation+%F0%9F%94%AC%22
32+
.. _`Designing or specifying a solution`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+design+proposal+%3Alock%3A%22%2C%22Needs+specification+%3Aclosed_lock_with_key%3A%22
33+
.. _`Giving your opinion on ongoing discussion`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+decision+%3Alock%3A%22
34+
.. _`Fixing false positives or bugs`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22False+Positive+%F0%9F%A6%9F%22%2C%22Bug+%3Abeetle%3A%22%2C%22Crash+%F0%9F%92%A5%22
35+
.. _`Creating new features or fixing false negatives`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22False+Negative+%F0%9F%A6%8B%22%2C%22Enhancement+%E2%9C%A8%22
36+
.. _`Reviewing pull requests`: https://github.com/PyCQA/pylint/pulls?q=is%3Aopen+is%3Apr+label%3A%22Needs+review+%F0%9F%94%8D%22
37+
38+
39+
If you are a pylint maintainer there's also:
40+
41+
- `Triaging issues`_
42+
- `Labeling issues that do not have an actionable label yet`_
43+
- `Preparing the next patch release`_
44+
- `Checking stale pull requests status`_
45+
46+
.. _`Triaging issues`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+triage+%3Ainbox_tray%3A%22
47+
.. _`Labeling issues that do not have an actionable label yet`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+-label%3A%22Needs+astroid+Brain+%F0%9F%A7%A0%22+-label%3A%22Needs+astroid+update%22+-label%3A%22Needs+backport%22+-label%3A%22Needs+decision+%3Alock%3A%22+-label%3A%22Needs+investigation+%F0%9F%94%AC%22+-label%3A%22Needs+PR%22+-label%3A%22Needs+reproduction+%3Amag%3A%22+-label%3A%22Needs+review+%F0%9F%94%8D%22+-label%3A%22Needs+triage+%3Ainbox_tray%3A%22+-label%3A%22Waiting+on+author%22+-label%3A%22Work+in+progress%22+-label%3AMaintenance+sort%3Aupdated-desc+-label%3A%22Needs+specification+%3Aclosed_lock_with_key%3A%22+-label%3A%22Needs+design+proposal+%3Alock%3A%22
48+
.. _`Preparing the next patch release`: https://github.com/PyCQA/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+backport%22
49+
.. _`Checking stale pull requests status`: https://github.com/PyCQA/pylint/pulls?q=is%3Aopen+is%3Apr+label%3A%22Work+in+progress%22%2C%22Needs+astroid+update%22%2C%22Waiting+on+author%22
50+
51+
52+
Creating a pull request
53+
-----------------------
54+
955
Got a change for Pylint? Below are a few steps you should take to make sure
1056
your patch gets accepted:
1157

doc/user_guide/configuration/all-options.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,14 @@ Standard Checkers
9999

100100
--ignore-paths
101101
""""""""""""""
102-
*Add files or directories matching the regex patterns to the ignore-list. The regex matches against paths and can be in Posix or Windows format. Because '\' represents the directory delimiter on Windows systems, it can't be used as an escape character.*
102+
*Add files or directories matching the regular expressions patterns to the ignore-list. The regex matches against paths and can be in Posix or Windows format. Because '\' represents the directory delimiter on Windows systems, it can't be used as an escape character.*
103103

104104
**Default:** ``[]``
105105

106106

107107
--ignore-patterns
108108
"""""""""""""""""
109-
*Files or directories matching the regex patterns are skipped. The regex matches against base names, not paths. The default value ignores Emacs file locks*
109+
*Files or directories matching the regular expression patterns are skipped. The regex matches against base names, not paths. The default value ignores Emacs file locks*
110110

111111
**Default:** ``(re.compile('^\\.#'),)``
112112

0 commit comments

Comments
 (0)