Skip to content

Latest commit

 

History

History
16 lines (11 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

16 lines (11 loc) · 1.16 KB
Raw

Contributing to Vaxrank

We would love your help in making Vaxrank a useful resource for the community. No contribution is too small, and we especially appreciate usability improvements like better documentation, tutorials, tests, or code cleanup.

Making a contribution

All contributions can be made as pull requests on Github. One of the core developers will review your contribution. As needed the core contributors will also make releases and submit to PyPI.

A few other guidelines:

  • Vaxrank supports 3.3+ on Linux and OS X. We don't guarantee support for Windows.
  • All functions should be documented using numpy-style docstrings and associated with unit tests.
  • Bugfixes should be accompanied with a test that illustrates the bug when feasible.
  • Contributions are licensed under Apache 2.0
  • Please adhere to our code of conduct.

Working on your first Pull Request? One resource that may be helpful is How to Contribute to an Open Source Project on GitHub.