Skip to content

Latest commit

 

History

History
93 lines (57 loc) · 2.06 KB

CONTRIBUTING.rst

File metadata and controls

93 lines (57 loc) · 2.06 KB
Raw

Issues and Bugs

If you have a bug report or idea for improvement, please create an issue on GitHub, or a pull request with the fix.

Contributors

Pull Request Checklist

  1. Verify tests pass:
tox
  1. If you have PyCharm, use it to see if your changes introduce any new static analysis warnings.
  2. Modify CHANGELOG.rst to say what you changed.

Maintainers

Review Checklist

On every pull request:

  1. Verify changes are sensible and in line with project goals.
  2. Verify tests pass (continuous integration is OK for this).
  3. Use PyCharm to check static analysis if changes are significant or non-trivial.
  4. Verify CHANGELOG.rst is modified as appropriate.
  5. Merge in.

Release Checklist

Prep

  1. Create release branch.
  2. Use git status to verify that no superfluous files are present to be included in the source distribution.
  3. Use check-manifest to update MANIFEST.in:
check-manifest -u
  1. Increment version number from last release according to PEP 0440 and roughly according to the Semantic Versioning guidelines.
  2. Modify CHANGELOG file:
  • Update version number.
  • Edit release notes for publication.
  1. Verify tests pass (continuous integration is OK for this).
  2. Merge release branch.

Checks

  1. Use check-manifest to verify that no files are missing:
check-manifest
  1. Use git status to verify that no superfluous files are present to be included in the source distribution.
  2. Build distributions:
python setup.py sdist bdist_wheel
  1. Visually inspect wheel distribution for correctness.

Release

  1. Upload to testpypi if changes impact PyPI (e.g., if README changed):
twine upload -r test  dist\ezoutlet-x.y.z-py2-none-any.whl dist\ezoutlet-0.0.1-dev3.zip
  1. Upload to pypi:
twine upload dist\ezoutlet-x.y.z-py2-none-any.whl dist\ezoutlet-0.0.1-dev3.zip
  1. Create accompanying release on GitHub.