Skip to content

Commit

Permalink
DOC: updated contributing
Browse files Browse the repository at this point in the history
Fixed missing information from pysatSpaceWeather.
  • Loading branch information
aburrell committed Oct 19, 2023
1 parent 5c51ecf commit 86d3031
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Contributing
============

Bug reports, feature suggestions, and other contributions are greatly
appreciated! pysat is a community-driven project and welcomes both feedback and
contributions.
appreciated! pysat and PACKAGENAME are community-driven projects and welcome
both feedback and contributions.

Come join us on Slack! An invitation to the pysat workspace is available
in the 'About' section of the
Expand Down Expand Up @@ -106,7 +106,7 @@ To set up `PACKAGENAME` for local development:
```
Where AAA is a standard shorthand for the type of change (eg, BUG or DOC).
`pysat` follows the [numpy development workflow](https://numpy.org/doc/stable/dev/development_workflow.html),
see the discussion there for a full list of this shorthand notation.
see the discussion there for a full list of this shorthand notation.

9. Once you are happy with the local changes, push to GitHub:
```
Expand All @@ -130,14 +130,14 @@ For merging, you should:
1. Include an example for use
2. Add a note to ``CHANGELOG.md`` about the changes
3. Update the author list in ``zenodo.json`` if applicable
4. Ensure that all checks passed (current checks include Github Actions and
Coveralls)
4. Ensure that all checks passed (current checks include GitHub Actions,
Coveralls, and ReadTheDocs)

If you don't have all the necessary Python versions available locally or
have trouble building all the testing environments, you can rely on
GitHub Actions to run the tests for each change you add in the pull
request. Because testing here will delay tests by other developers,
please ensure that the code passes all tests on your local system first.
If you don't have all the necessary Python versions available locally or have
trouble building all the testing environments, you can rely on GitHub Actions to
run the tests for each change you add in the pull request. Because testing here
will delay tests by other developers, please ensure that the code passes all
tests on your local system first.


Project Style Guidelines
Expand Down Expand Up @@ -167,7 +167,8 @@ These include:
* All classes should have `__repr__` and `__str__` functions
* Docstrings use `Note` instead of `Notes`
* Try to avoid creating a try/except statement where except passes
* Use setup_method (or setup_class) and teardown_method (or teardown_class) in test classes
* Use setup_method (or setup_class) and teardown_method (or teardown_class) in
test classes
* Use pytest parametrize in test classes when appropriate
* Use pysat testing utilities when appropriate
* Provide testing class methods with informative failure statements and
Expand Down

0 comments on commit 86d3031

Please sign in to comment.