Development

Contribution Guideline

Jazzband

This is a Jazzband project. By contributing you agree to abide by the Contributor Code of Conduct and follow the guidelines.

Setup development environment

  • Requires supported Python version

  • do setup under django-redshift-backend.git repository root as:

    $ pip install -U pip setuptools wheel setuptools_scm
    $ pip install -r dev-requires.txt
    

Testing

Run test

Just run tox:

$ tox

tox have several sections for testing.

CI (Continuous Integration)

All tests will be run on Travis CI service.

Releasing

New package version

The django-redshift-backend package will be uploaded to PyPI: https://pypi.org/project/django-redshift-backend/.

Here is a release procefure for releasing.

Procedure:

  1. check travis-ci testing result: https://travis-ci.org/jazzband/django-redshift-backend
  2. update release version/date in CHANGES.rst
  3. tagging with version name that MUST following semver. e.g.: git tag 1.0.1
  4. git push --tags to invoke release process on travis-ci.
  5. approve release files. please check your email or https://jazzband.co/projects/django-redshift-backend
  6. check PyPI page: https://pypi.org/p/django-redshift-backend
  7. bump version in CHANGES.rst and commit/push them onto GitHub

Updated documentation

Sphinx documentation under doc/ directory on the master branch will be automatically uploaded into ReadTheDocs: http://django-redshift-backend.rtfd.io/.