Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 2.32 KB
Raw

How to contribute

We welcome contributions from external contributors, and this document describes how to merge code changes into this repository.

Getting Started

  1. Make sure you have a GitHub account.
  2. Fork this repository on GitHub.
  3. On your local machine, clone your fork of the repository.
  4. install the package with developer extras: pip install -e .[dev]
  5. run: pre-commit install
  6. start making changes!

Making Changes

  • Add some really awesome code to your local fork. It's usually a good idea to make changes on a branch with the branch name relating to the feature you are going to add.
  • When you are ready for others to examine and comment on your new feature, navigate to your fork of dsp on GitHub and open a pull request (PR). Note that after you launch a PR from one of your fork's branches, all subsequent commits to that branch will be added to the open pull request automatically. Each commit added to the PR will be validated for mergability, compilation and test suite compliance; the results of these tests will be visible on the PR page.
  • If you're providing a new feature, you must add test cases and documentation.
  • Complete the PR checklist:
  • linting: pre-commit run -a
  • (if appropriate) unit tests added: pytest
  • When you're ready to be considered for merging, check the "Ready to go" box on the PR page to let the dsp devs know that the changes are complete. The code will not be merged until this box is checked, the continuous integration returns checkmarks, and multiple core developers give "Approved" reviews.

Additional Resources