@@ -6,29 +6,9 @@ Contribute
6
6
Pylint is developed using git _. We recommend using Python 3.8 or higher
7
7
as it gives you access to the latest ``ast `` parser.
8
8
9
- You can clone Pylint using ::
9
+ * ` Create your own fork `_ of pylint before cloning it.
10
10
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,
32
12
so you will likely need to interact with :mod: `astroid `.
33
13
A short example of how to use :func: `astroid.extract_node ` is given
34
14
:ref: `here <astroid_extract_node >`.
@@ -37,18 +17,26 @@ Getting Started
37
17
message to find where the warning is raised,
38
18
and therefore where the logic for that code exists.
39
19
20
+ * Test your code :ref: `using the documentation <testing >`.
21
+
40
22
* When adding a new checker class you can use the :file: `get_unused_message_id_category.py `
41
23
script in :file: `./script ` to get a message id that is not used by
42
24
any of the other checkers.
43
25
44
- Building the documentation
45
- ----------------------------
46
-
47
- You can use the makefile in the doc directory with ``make html `` to build the
48
- documentation. To test smaller changes you can consider ``build-html ``, which skips some checks but will be faster::
26
+ * You can use the makefile in the doc directory with ``make html `` to build the documentation.
27
+ To test smaller changes you can consider ``build-html ``, which skips some checks but will
28
+ be faster::
49
29
50
30
$ cd doc
51
31
$ make install-dependencies
52
32
$ make build-html
53
33
54
34
We're reusing generated files for speed, use ``make clean `` when you want to start from scratch.
35
+
36
+ * Send a pull request from GitHub (see `About pull requests `_ for more insight about this topic)
37
+
38
+ .. _git : https://git-scm.com/
39
+ .. _`Create your own fork` : https://docs.github.com/en/get-started/quickstart/fork-a-repo
40
+ .. _`About pull requests` : https://support.github.com/features/pull-requests
41
+ .. _astroid : https://github.com/pycqa/astroid
42
+ >>>>>>> Cleanup of contribute
0 commit comments