Contributing to naturf

Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make naturf more robust, you are welcome to contribute!

Opening issues

If you find a bug or would like to contribute a new feature, please open an issue and select the template that fits your need.

Contribution workflow

The following is the recommended workflow for contributing to naturf:

  1. Fork the naturf repository and then clone it locally:

git clone https://github.com/<your-user-name>/naturf

Cloning the repository will give you access to the test suite. It is important to install the package in development mode before running tests. This will give you the flexibility to make changes in the code without having to rebuild your package before running tests. :

cd naturf

pip install -e .

Install `pre-commit`, then install the hooks within the repo to auto format code:

pre-commit install

  1. Create a branch for your changes

git checkout -b bug/some-bug

# or

git checkout -b feature/some-feature

  1. Add your recommended changes and ensure all tests pass, then commit your changes:

    Ensure your tests pass locally before pushing to your remote branch where GitHub actions will launch CI services to build the package, run the test suite, and evaluate code coverage. To do this, ensure that pytest has been installed then navigate to the root of your cloned directory (e.g., <my-path>/naturf) and simply execute pytest in the terminal.

git add <my-file-name>

git commit -m '<my short message>'

Changes to the documentation can be made in the naturf/docs/source directory containing the RST files. To view your changes, ensure you have the development dependencies of naturf installed and run the following from the naturf/docs/source directory:

make html

This will generate your new documentation in a directory named naturf/docs/build/html. You can open the index.html in your browser to view the documentation site locally. If your changes are merged into the main branch of naturf, changes in your documentation will go live as well.

  1. Push your changes to the remote

git push origin <my-branch-name>

  1. Submit a pull request with the following information:

  • Purpose: The reason for your pull request in short

  • Summary: A description of the environment you are using (OS, Python version, etc.), logic, any caveats, and a summary of changes that were made.

  1. If approved, your pull request will be merged into the main branch by a naturf admin and a release will be conducted subsequently. naturf uses semantic naming for versioned releases. Each release receives a DOI via a linked Zenodo service automatically.

Developer Guide

To push naturf to pypi, you should first have build and twine installed:

python3 -m pip install --upgrade build

python3 -m pip install --upgrade twine

You also need to set up a PyPi account and API token

Then run:

python -m build

twine upload dist/*