Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.6 KB

CONTRIBUTING.rst

File metadata and controls

37 lines (30 loc) · 1.6 KB
Raw

Contributing

If you would like to contribute to Pydora please visit the project's GitHub page and open a pull request with your changes. To have the best experience contributing, please:

  • Don't break backwards compatibility of public interfaces
  • Write tests for your new feature/bug fix
  • Ensure that existing tests pass
  • Update the readme/docstrings, if necessary
  • Follow the coding style of the current code-base
  • Ensure that your code is PEP8 compliant
  • Validate that your changes work with Python 3.5+

All code is reviewed before acceptance and changes may be requested to better follow the conventions of the existing API.

The build system runs tox -e tests,release on all supported Python versions. You can, and should, run this on your pull request before submitting.

Building a Release

Official releases are built and uploaded to PyPi using the GitHub release workflow. To prepare a release, first, bump the __version__ string in pandora/__init__.py and push a new release branch with the name release-${version} where ${version} is the version number from pandora/__init__.py. The GitHub workflow will do the rest.

The workflow does the same thing that is documented above with the addition of an upload to PyPi.