Skip to content

Commit b0a71db

Browse files
committed
Doubled text for using pylint in contributing section
1 parent bd0da9a commit b0a71db

1 file changed

Lines changed: 6 additions & 28 deletions

File tree

docs/source/contributing/development.rst

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -79,28 +79,17 @@ Standard GitHub Workflow
7979
folders for PyCharm and :code:`.vscode` folders for VS Code are not
8080
committed by updating the :code:`.gitignore` file.
8181

82-
10. Improve code readability by linting it. Run :code:`pylint` to preview
83-
issues with the code:
82+
10. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
8483

85-
.. code-block:: bash
86-
87-
poetry run python -m pylint path-to-file-to-lint
88-
89-
Resolve issues that do not impact how you have implemented your functionality,
90-
such as conforming to snake case naming, removing TODOs and using suggested
91-
defaults.
92-
93-
11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
94-
95-
12. Commit your changes and publish your branch to GitHub:
84+
11. Commit your changes and publish your branch to GitHub:
9685

9786
.. code-block:: bash
9887
9988
git add -A
10089
git commit -m "<describe changes in this commit>"
10190
git push origin your-name/name-of-your-bugfix-or-feature
10291
103-
13. Submit a pull request through GitHub. For the base branch
92+
12. Submit a pull request through GitHub. For the base branch
10493
in the pull request, select the latest version release branch :code:`vX.Y.Z`
10594
(with the highest number of all such branches). *Do not target the*
10695
:code:`main` *branch in your pull request.* In the pull request,
@@ -173,20 +162,9 @@ NAVLab GitHub Workflow
173162
folders for PyCharm and :code:`.vscode` folders for VS Code are not
174163
committed by updating the :code:`.gitignore` file.
175164

176-
10. Improve code readability by linting it. Run :code:`pylint` to preview
177-
issues with the code:
178-
179-
.. code-block:: bash
180-
181-
poetry run python -m pylint path-to-file-to-lint
182-
183-
Resolve issues that do not impact how you have implemented your functionality,
184-
such as conforming to snake case naming, removing TODOs and using suggested
185-
defaults.
186-
187-
11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
165+
10. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
188166

189-
12. When you're ready to commit changes follow the steps below to
167+
11. When you're ready to commit changes follow the steps below to
190168
minimize unnecessary merging. This is especially important if
191169
multiple people are working on the same branch. If you pull new
192170
changes, then repeat the tests above to double check that everything
@@ -201,7 +179,7 @@ NAVLab GitHub Workflow
201179
git commit -m "<describe changes in this commit>"
202180
git push origin your-name/name-of-your-bugfix-or-feature
203181
204-
13. Submit a pull request through GitHub. For the base branch
182+
12. Submit a pull request through GitHub. For the base branch
205183
in the pull request, select the latest version release branch :code:`vX.Y.Z`
206184
(with the highest number of all such branches). *Do not target the*
207185
:code:`main` *branch in your pull request.* In the pull request,

0 commit comments

Comments
 (0)