Contributing overview#
Before contributing#
Welcome to xarray-einstats! Before contributing to the project, make sure that you read our code of conduct
Contributing code#
Set up a Python development environment (advice: use venv, virtualenv, or miniconda)
Install tox:
python -m pip install tox
Clone the repository
Start a new branch off main:
git switch -c new-branch main
Install the library in editable mode:
pip install -e .
(note: requirespip>=21.3
)Make your code changes (and try them as you work)
Check that your code follows the style guidelines of the project:
tox -e reformat && tox -e check
(optional) Build the documentation with
tox -e docs
. Note that tox commandscleandocs
andviewdocs
, more details about each command in Contributing reference are also available(optional) Run the tests:
tox -e py39
(change the version number according to the Python you are using)Commit, push, and open a pull request!