@@ -11,6 +11,13 @@ create a branch, make changes, ensure the code is linted and the tests pass, add
11
11
where relevant, and submit a pull request. At this point the continuous integration
12
12
workflows will run and we will engage a more detailed discussion in reviewing the changes.
13
13
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
+
14
21
## Types of Contributions
15
22
16
23
### Report Bugs
@@ -167,8 +174,7 @@ Before you submit a pull request, check that it meets these guidelines:
167
174
1 . The pull request should include [ pytest] ( https://docs.pytest.org/ ) tests and,
168
175
where relevant, [ xdoctest] ( https://github.com/Erotemic/xdoctest )
169
176
[ 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