Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.72 KB
Raw

Want to contribute?

Great! That's why this is an open source project. We use this project in our infrastructure at Uber, and we hope that it's useful to others as well.

Before you get started, here are some suggestions:

  • Check open issues for what you want.
  • If there is an open issue, comment on it. Otherwise open an issue describing your bug or feature with use cases.
  • Before undertaking a major change, please discuss this on the issue. We'd hate to see you spend a lot of time working on something that conflicts with other goals or requirements that might not be obvious.
  • Write code to fix the problem, then open a pull request with tests and documentation.
  • The pull requests gets reviewed and then merged assuming there are no problems.
  • A new release version gets cut.

Licencing

  • Every file must have a licence block at the top. This is enforced using uber-licence
  • If you contribute to a file in this project and are not an Uber employee, then you should add your name to the copyright section of the licence file.
  • Work that you contribute must be your own.

Releases

Declaring formal releases requires peer review.

  • A reviewer of a pull request should recommend a new version number (patch, minor or major).
  • Once your change is merged feel free to bump the version as recommended by the reviewer.
  • A new version number should not be cut without peer review unless done by the project maintainer.

Cutting a new version

Releases

Before new release, add a summary of changes since last version to (CHANGELOG.rst)[./CHANGELOG.rst].

pip install zest.releaser[recommended]
prerelease
release
git push origin master --follow-tags
python setup.py sdist upload -r pypi
postrelease
git push