Skip to content

Commit 77d9fea

Browse files
committed
add comments on additional documentation needed for new functionality
1 parent a25b6c5 commit 77d9fea

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/source/contributing/development.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ Standard GitHub Workflow
3333
5. Make changes locally and document them appropriately. See the
3434
:ref:`Documentation<documentation>` section for more details.
3535

36+
If the feature branch includes new functionality, you must also:
37+
38+
* update the "Code Organization" section of the :code:`README.md`
39+
* update the "Code Organization" section of
40+
:code:`docs/source/index.rst` to match the :code:`README.md`
41+
* add a section in the appropriate tutorial notebook located in
42+
:code:`notebooks/tutorials/*`
43+
3644
6. Add tests for the newly added code and ensure the new code is covered.
3745
See the :ref:`Testing<testing>` section for more details.
3846

@@ -87,6 +95,14 @@ NAVLab GitHub Workflow
8795
4. Make changes locally and document them appropriately. See the
8896
:ref:`Documentation<documentation>` section for more details.
8997

98+
If the feature branch includes new functionality, you must also:
99+
100+
* update the "Code Organization" section of the :code:`README.md`
101+
* update the "Code Organization" section of
102+
:code:`docs/source/index.rst` to match the :code:`README.md`
103+
* add a section in the appropriate tutorial notebook located in
104+
:code:`notebooks/tutorials/*`
105+
90106
5. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.sh>`__.
91107

92108
6. When you're done making changes run all the tests with:
@@ -156,6 +172,16 @@ Pull Request Review Workflow
156172
the :ref:`Documentation<documentation>` section for more details on
157173
what is expected.
158174

175+
If the feature branch included new functionality, the following
176+
should have also been updated:
177+
178+
* the "Code Organization" section of the :code:`README.md`
179+
* the "Code Organization" section of
180+
:code:`docs/source/index.rst` to match the :code:`README.md`
181+
* the appropriate tutorial notebook located in
182+
:code:`notebooks/tutorials/*` with a simple example of the new
183+
functionality
184+
159185
4. Verify that all tests run on your system:
160186

161187
.. code-block:: bash

0 commit comments

Comments
 (0)