Skip to content

Commit 16c654c

Browse files
nit(contributing): remove extra PR list element
Signed-off-by: Cameron Smith <cameron.ray.smith@gmail.com>
1 parent 267604c commit 16c654c

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

nbs/about/contributing.qmd

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ create a branch, make changes, ensure the code is linted and the tests pass, add
1111
where relevant, and submit a pull request. At this point the continuous integration
1212
workflows will run and we will engage a more detailed discussion in reviewing the changes.
1313

14+
::: {#nte-contributing .callout-note collapse=true title="Current state of the repository"}
15+
Please note that pyrovelocity is still in the early stages of development.
16+
The current state of the documentation and repository are not complete
17+
with respect to the procedures for contributing outlined here; however,
18+
we plan to respect them as we continue to develop the project.
19+
:::
20+
1421
## Types of Contributions
1522

1623
### Report Bugs
@@ -167,8 +174,7 @@ Before you submit a pull request, check that it meets these guidelines:
167174
1. The pull request should include [pytest](https://docs.pytest.org/) tests and,
168175
where relevant, [xdoctest](https://github.com/Erotemic/xdoctest)
169176
[doctests](https://docs.python.org/3/library/doctest.html).
170-
2. If the pull request adds functionality, the
171-
3. [Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
172-
and [docs](https://github.com/pinellolab/pyrovelocity/tree/main/nbs) should be updated.
173-
5. The pull request should pass the CI execution for the primary supported python version (currently Python 3.10).
174-
177+
1. If the pull request adds or significantly modifies functionality, the relevant
178+
[Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
179+
and [docs](https://github.com/pinellolab/pyrovelocity/tree/main/nbs) should likely be updated.
180+
1. The pull request should pass the CI execution for the primary supported python version (currently Python 3.10).

0 commit comments

Comments
 (0)