Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

74 lines (46 loc) · 2.82 KB

Contributing to pyRTE-RRTMGP

Thanks for considering making a contribution to pyRTE-RRTMGP!

How to Report a Bug?

Please file a bug report on the GitHub page. If possible, your issue should include a minimal, complete, and verifiable example of the bug.

How to Propose a New Feature?

Please file a feature request on the GitHub page.

How to Set up a Local Development Environment?

Please follow the instructions for installing pyRTE-RRTMTP with pip in the documentation.

How to Contribute to the Documentation?

The documentation uses Sphinx and is located in the docs directory.

To build the documentation locally, first install the required documentation dependencies (optimally in a dedicated virtual environment):

pip install -r docs/requirements-doc.txt

Then, build the documentation:

cd docs
make html

The built documentation will be located in docs/build/html.

How to Run and Update Tests?

pyRTE-RRTMTP uses pytest for testing. To run the tests, first install the required testing dependencies (optimally in a dedicated virtual environment):

pip install -r tests/requirements-test.txt

Then, run the tests:

pytest tests

How to Contribute a Patch That Fixes a Bug?

Please fork this repository, branch from main, make your changes, and open a GitHub pull request against the main branch.

How to Contribute New Features?

Please fork this repository, branch from main, make your changes, and open a GitHub pull request against the main branch.

Pull Requests for new features should include tests and documentation.

How to Make a New Release?

For maintainers:

  1. To make a new release, update the version number in pyproject.toml and conda.recipe/meta.yaml. Also update CITATION.cff as necessary.
  2. Then, create a new release off the main branch on GitHub, using the "Draft a new release" button in https://github.com/earth-system-radiation/pyRTE-RRTMGP/releases.
  3. Create a new tag with the version number, and use the "Generate release notes" button to create the release notes.
  4. Review and update the the release notes as necessary, and publish the release and set it as the latest release.

The documentation on https://pyrte-rrtmgp.readthedocs.io/ will update automatically.