@@ -14,26 +14,24 @@ Standard GitHub Workflow
1414------------------------
1515
16161. Fork `gnss_lib_py <https://github.com/Stanford-NavLab/gnss_lib_py >`__
17- (look for the "Fork" button).
18-
19- 2. Clone your fork locally:
17+ (look for the "Fork" button), then clone your fork locally:
2018
2119 .. code-block :: bash
2220
2321 git clone https://github.com/< your username> /gnss_lib_py
2422
25- 3 . If using poetry, follow the :ref: `developer install instructions<developer install> `
23+ 2 . If using poetry, follow the :ref: `developer install instructions<developer install> `
2624 to install pyenv, poetry, and the python dependencies. If using
2725 :code: `pip ` or :code: `conda ` for package management instead, use
2826 :code: `pip install -r requirements.txt ` to install dependencies.
2927
30- 4 . Create a local branch:
28+ 3 . Create a local branch:
3129
3230 .. code-block :: bash
3331
3432 git checkout -b your-name/name-of-your-bugfix-or-feature
3533
36- 5 . Make changes locally and document them appropriately. See the
34+ 4 . Make changes locally and document them appropriately. See the
3735 :ref: `Documentation<documentation> ` section for more details.
3836
3937 If the feature branch includes new functionality, you must also:
@@ -44,18 +42,18 @@ Standard GitHub Workflow
4442 * add a section in the appropriate tutorial notebook located in
4543 :code: `notebooks/tutorials/* `
4644
47- 6 . Add tests for the newly added code and ensure the new code is covered.
45+ 5 . Add tests for the newly added code and ensure the new code is covered.
4846 See the :ref: `Testing<testing> ` section for more details.
4947
50- 7 . When you're done making changes run all the tests with:
48+ 6 . When you're done making changes run all the tests with:
5149
5250 .. code-block :: bash
5351
5452 poetry run pytest
5553
5654 Make sure that all tests are passing.
5755
58- 8 . Verify that testing coverage has not decreased:
56+ 7 . Verify that testing coverage has not decreased:
5957
6058 .. code-block :: bash
6159
@@ -64,7 +62,7 @@ Standard GitHub Workflow
6462
6563 See the :ref: `Coverage Report<coverage> ` section for more details.
6664
67- 9 . Improve code readability by linting it. Run :code: `pylint ` to preview
65+ 8 . Improve code readability by linting it. Run :code: `pylint ` to preview
6866 issues with the code:
6967
7068 .. code-block :: bash
@@ -75,11 +73,22 @@ Standard GitHub Workflow
7573 such as conforming to snake case naming, removing TODOs and using suggested
7674 defaults.
7775
78- 10. Ensure that system and IDE dependent files, like those in :code: `.idea `
79- folders for PyCharm and :code: `.vscode ` folders for VS Code are not
80- committed by updating the :code: `.gitignore ` file.
76+ 9. Ensure that system and IDE dependent files, like those in :code: `.idea `
77+ folders for PyCharm and :code: `.vscode ` folders for VS Code are not
78+ committed by updating the :code: `.gitignore ` file.
79+
80+ 10. Improve code readability by linting it. Run :code: `pylint ` to preview
81+ issues with the code:
82+
83+ .. code-block :: bash
84+
85+ poetry run python -m pylint path-to-file-to-lint
86+
87+ Resolve issues that do not impact how you have implemented your functionality,
88+ such as conforming to snake case naming, removing TODOs and using suggested
89+ defaults.
8190
82- 11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.sh >`__.
91+ 11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md >`__.
8392
849312. Commit your changes and publish your branch to GitHub:
8594
@@ -89,7 +98,13 @@ Standard GitHub Workflow
8998 git commit -m " <describe changes in this commit>"
9099 git push origin your-name/name-of-your-bugfix-or-feature
91100
92- 13. Submit a pull request through GitHub.
101+ 13. Submit a pull request through GitHub. For the base branch
102+ in the pull request, select the latest version release branch :code: `vx.Y.Z `
103+ (with the highest number of all such branches). *Do not target the *
104+ :code: `main ` *branch in your pull request. * In the pull request,
105+ add a code review request for a current maintainer of the repository.
106+ The reviewers might add comments to ensure compliance with the rest
107+ of the code.
93108
94109.. _navlab_dev :
95110
@@ -119,15 +134,16 @@ NAVLab GitHub Workflow
119134 * add a section in the appropriate tutorial notebook located in
120135 :code: `notebooks/tutorials/* `
121136
122- 5. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.sh >`__.
137+ 5. Add tests for the newly added code and ensure the new code is covered.
138+ See the :ref: `Testing<testing> ` section for more details.
123139
1241406. When you're done making changes run all the tests with:
125141
126142 .. code-block :: bash
127143
128144 poetry run pytest
129145
130- See the :ref: ` Testing<testing> ` section for more details .
146+ Make sure that all tests are passing .
131147
1321487. Verify that testing coverage has not decreased:
133149
@@ -138,11 +154,7 @@ NAVLab GitHub Workflow
138154
139155 See the :ref: `Coverage Report<coverage> ` section for more details.
140156
141- 8. Ensure that system and IDE dependent files, like those in :code: `.idea `
142- folders for PyCharm and :code: `.vscode ` folders for VS Code are not
143- committed by updating the :code: `.gitignore ` file.
144-
145- 9. Improve code readability by linting it. Run :code: `pylint ` to preview
157+ 8. Improve code readability by linting it. Run :code: `pylint ` to preview
146158 issues with the code:
147159
148160 .. code-block :: bash
@@ -153,7 +165,24 @@ NAVLab GitHub Workflow
153165 such as conforming to snake case naming, removing TODOs and using suggested
154166 defaults.
155167
156- 10. When you're ready to commit changes follow the steps below to
168+ 9. Ensure that system and IDE dependent files, like those in :code: `.idea `
169+ folders for PyCharm and :code: `.vscode ` folders for VS Code are not
170+ committed by updating the :code: `.gitignore ` file.
171+
172+ 10. Improve code readability by linting it. Run :code: `pylint ` to preview
173+ issues with the code:
174+
175+ .. code-block :: bash
176+
177+ poetry run python -m pylint path-to-file-to-lint
178+
179+ Resolve issues that do not impact how you have implemented your functionality,
180+ such as conforming to snake case naming, removing TODOs and using suggested
181+ defaults.
182+
183+ 11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md >`__.
184+
185+ 12. When you're ready to commit changes follow the steps below to
157186 minimize unnecessary merging. This is especially important if
158187 multiple people are working on the same branch. If you pull new
159188 changes, then repeat the tests above to double check that everything
@@ -168,13 +197,13 @@ NAVLab GitHub Workflow
168197 git commit -m " <describe changes in this commit>"
169198 git push origin your-name/name-of-your-bugfix-or-feature
170199
171- 11 . Submit a pull request through the GitHub website . For the base branch
200+ 13 . Submit a pull request through GitHub. For the base branch
172201 in the pull request, select the latest version release branch :code: `vx.Y.Z `
173202 (with the highest number of all such branches). *Do not target the *
174203 :code: `main ` *branch in your pull request. * In the pull request,
175- add a code review request for the current maintainers of the repository,
176- Ashwin Kanhere or Derek Knowles. The reviewers
177- might add comments to ensure compliance with the rest of the code.
204+ add a code review request for a current maintainer of the repository.
205+ The reviewers might add comments to ensure compliance with the rest
206+ of the code.
178207
179208.. _pr_review :
180209
0 commit comments