Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
70 lines (48 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
70 lines (48 loc) · 1.47 KB

Contributing to dance

Thank you for your interest in contributing to the dance package! We welcome any kinds of contributions such as introducing new features, implementing bug fixes or additional unit tests, fixing typos or or improving the documentation in general.

To get started,

  1. Make a fork of the dance repository and create a new branch, e.g., yourname-yourpatch, where you will make your changes there.
  2. After you are done with the new changes and have successfully passed our quality checks, make a Pull Request for you changes with descriptions and reasons about the patch.

Dev notes

Dev installation

Install PyDANCE with extra dependencies for dev

pip install -e ."[dev]"

Make sure dependencies have specific pinned versions

pip install -r requirements.txt

Install pre-commit hooks for code quality checks

pre-commit install

Run tests

Run all tests on current environment using pytest

pytest -v

Run full test from the ground up including environment set up using tox on CPU

tox -e python3.8-cpu

Building documentation

  1. Install dance with doc dependencies

    pip install -e ."[doc]"

  2. Build the documentation

    cd docs
make html

You can now view the documentation page by opening docs/build/html/index.html