Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.09 KB

Contributing

The best way to support the development of convtools is to spread the word!

Also, if you already are a convtools user, we would love to hear about your use cases and challenges in the Discussions section.

To report a bug or suggest enhancements, please open an issue and/or submit a pull request.

Reporting a Security Vulnerability: see the security policy.

Pull requests

Unless your change is trivial, please start a discussion or submit an issue to discuss before creating a pull request.

  1. clone the repo
  2. install python 3.10
  3. install dev requrements: pip install -r ci-requirements/requirements3.10.out
  4. make a change
  5. make sure tests are passed: pytest
  6. make sure checks are passed: make checks
  7. make sure docs are building: make docs
  8. include the info to be put into the changelog in PR description
  9. commit the changes and open a pull request