Skip to content

Commit 84857b3

Browse files
Cleanup of contribute
1 parent a4af354 commit 84857b3

File tree

1 file changed

+12
-26
lines changed

1 file changed

+12
-26
lines changed

doc/developer_guide/contribute.rst

+12-26
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,9 @@ Contribute
66
Pylint is developed using git_. We recommend using Python 3.8 or higher
77
as it gives you access to the latest ``ast`` parser.
88

9-
You can clone Pylint using ::
9+
* `Create your own fork`_ of pylint before cloning it.
1010

11-
git clone https://github.com/PyCQA/pylint
12-
13-
.. _git: https://git-scm.com/
14-
15-
- Document your change, if it is a non-trivial one.
16-
17-
- Send a pull request from GitHub (see `About pull requests`_ for more insight
18-
about this topic)
19-
20-
.. _`About pull requests`: https://support.github.com/features/pull-requests
21-
.. _astroid: https://github.com/pycqa/astroid
22-
23-
24-
Getting Started
25-
---------------
26-
27-
* Read the :ref:`technical-reference`. It gives a short walk through of the pylint
28-
codebase and will help you identify where you will need to make changes
29-
for what you are trying to implement.
30-
31-
* :func:`astroid.extract_node` is your friend. Most checkers are AST based,
11+
* Read about :func:`astroid.extract_node`. Most checkers are AST based,
3212
so you will likely need to interact with :mod:`astroid`.
3313
A short example of how to use :func:`astroid.extract_node` is given
3414
:ref:`here <astroid_extract_node>`.
@@ -37,13 +17,19 @@ Getting Started
3717
message to find where the warning is raised,
3818
and therefore where the logic for that code exists.
3919

20+
* Test your code :ref:`using the documentation <testing>`.
21+
4022
* When adding a new checker class you can use the :file:`get_unused_message_id_category.py`
4123
script in :file:`./script` to get a message id that is not used by
4224
any of the other checkers.
4325

44-
Building the documentation
45-
----------------------------
46-
47-
We use **tox** for building the documentation::
26+
* Document your change, if it is a non-trivial one. We use **tox** for building the documentation::
4827

4928
$ tox -e docs
29+
30+
* Send a pull request from GitHub (see `About pull requests`_ for more insight about this topic)
31+
32+
.. _git: https://git-scm.com/
33+
.. _`Create your own fork`: https://docs.github.com/en/get-started/quickstart/fork-a-repo
34+
.. _`About pull requests`: https://support.github.com/features/pull-requests
35+
.. _astroid: https://github.com/pycqa/astroid

0 commit comments

Comments
 (0)