Skip to content

Commit 3ac8781

Browse files
Upgrade contribute doc with discord server and fix typoes
1 parent e6a22d1 commit 3ac8781

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

doc/development_guide/contribute.rst

+20-20
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,25 @@ Please take the time to check if it is already in the issue tracker at
1616
https://github.com/PyCQA/pylint
1717

1818
If you cannot find it in the tracker, create a new issue there or discuss your
19-
problem on the [email protected] mailing list.
19+
problem on the [email protected] mailing list or using the discord server https://discord.gg/kFebW799.
2020

2121
The code-quality mailing list is also a nice place to provide feedback about
2222
Pylint, since it is shared with other tools that aim at improving the quality of
2323
python code.
2424

25-
Note that if you don't find something you have expected in Pylint's
26-
issue tracker, it may be because it is an issue with one of its dependencies, namely
25+
Note that if you don't find something you have expected in Pylint's issue
26+
tracker, it may be because it is an issue with one of its dependencies, namely
2727
astroid:
2828

2929
* https://github.com/PyCQA/astroid
3030

3131
.. _Mailing lists:
3232

33+
Discord server
34+
--------------
35+
36+
https://discord.gg/kFebW799
37+
3338
Mailing lists
3439
-------------
3540

@@ -62,14 +67,14 @@ your patch gets accepted.
6267

6368
- Test your code
6469

65-
* Pylint is very well tested, with a high good code coverage.
70+
* Pylint is very well tested, with a high code coverage.
6671
It has two types of tests, usual unittests and functional tests.
6772

6873
The usual unittests can be found under `/pylint/test` directory and they can
6974
be used for testing almost anything Pylint related. But for the ease
7075
of testing Pylint's messages, we also have the concept of functional tests.
7176

72-
* You should also run all the tests to ensure that your change isn't
77+
* You should also run all the tests to ensure that your change isn't a
7378
breaking one. You can run the tests using the tox_ package, as in::
7479

7580
python -m tox
@@ -95,15 +100,14 @@ your patch gets accepted.
95100

96101
pytest pylint -k test_functional
97102

98-
* ``pylint`` uses black_ and isort_ Python autoformatter for formatting its code.
99-
We have a pre-commit hook which should take care of the autoformatting for you
100-
for when you are working on a patch. To enable it, do the following:
103+
* ``pylint`` uses black_ and isort_ among other Python autoformatters.
104+
We have a pre-commit hook which should take care of the autoformatting for
105+
you. To enable it, do the following:
101106

102107
* install ``pre-commit`` using ``pip install pre-commit``
103108

104109
* then run ``pre-commit install`` in the ``pylint`` root directory to enable the git hooks.
105110

106-
107111
- Add a short entry to the ChangeLog describing the change, except for internal
108112
implementation only changes. Not usually required, but for changes other than small
109113
bugs we also add a couple of sentences in the release document for that release,
@@ -112,7 +116,7 @@ your patch gets accepted.
112116

113117
- Add a short entry in :file:`doc/whatsnew/VERSION.rst`.
114118

115-
- Add yourself to the `CONTRIBUTORS` file, flag youself appropriately
119+
- Add yourself to the `CONTRIBUTORS` file, flag yourself appropriately
116120
(if in doubt, you're a ``contributor``).
117121

118122
- Write a comprehensive commit message
@@ -146,15 +150,11 @@ If multiple messages are expected on the same line, then this syntax can be used
146150

147151
a, b, c = 1.test # [unbalanced-tuple-unpacking, no-member]
148152

149-
The syntax of the .txt file has to be this::
150-
151-
symbol:line_number:function_or_class:Expected message
152-
153-
For example, this is a valid message line::
153+
You can also use ``# +n: [`` with n an integer if the above syntax would make the line too long or other reasons::
154154

155-
abstract-class-instantiated:79:main:Abstract class 'BadClass' with abstract methods instantiated
155+
# +1: [empty-comment]
156+
#
156157

157-
If the Python file is expected to not emit any errors, then the .txt file has to be empty.
158158
If you need special control over Pylint's flag, you can also create a .rc file, which
159159
can have sections of Pylint's configuration.
160160

@@ -163,8 +163,8 @@ current environment in order to have faster feedback. Run from Pylint root direc
163163

164164
python tests/test_functional.py
165165

166-
You can use all the options you would use for pytest, for example `-k "test_functional[len_checks]"`.
167-
It is also possible to update the expected output instead of using it for comparison, by appending
166+
You can use all the options you would use for pytest, for example `-k "test_functional[len_checks]"`.
167+
If required the .txt file can be re-generated from the current output by appending
168168
`--update-functional-output` to the command line::
169169

170170
python tests/test_functional.py --update-functional-output -k "test_functional[len_checks]"
@@ -180,7 +180,7 @@ It is also possible to update the expected output instead of using it for compar
180180

181181
Tips for Getting Started with Pylint Development
182182
------------------------------------------------
183-
* Read the :ref:`technical-reference`. It gives a short walkthrough of the pylint
183+
* Read the :ref:`technical-reference`. It gives a short walk through of the pylint
184184
codebase and will help you identify where you will need to make changes
185185
for what you are trying to implement.
186186

0 commit comments

Comments
 (0)