Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.18 KB

CONTRIBUTING.rst

File metadata and controls

76 lines (51 loc) · 2.18 KB
Raw
Jazzband

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

Contribute

  • Submit issues to the issue tracker on Github.
  • Fork the source code at Github.
  • Write some code and make sure it is covered with unit tests.
  • Send a pull request with your changes.
  • Provide a translation using Transifex.

Local installation

Install the development dependencies, which also installs the package in editable mode for local development and additional development tools.

pip install -r requirements_dev.txt

Running tests

This project aims for full code-coverage, this means that your code should be well-tested. Also test branches for hardened code. You can run the full test suite with:

make test

Or run a specific test with:

make test TARGET=tests.tests.TwilioGatewayTest

For Python compatibility, tox_ is used. You can run the full test suite, covering all supported Python and Django version with:

tox

Releasing

The following actions are required to push a new version:

  • Update release notes and version number in pyproject.toml and docs/conf.py

  • If any new translations strings were added, push the new source language to Transifex. Make sure translators have sufficient time to translate those new strings:

    make tx-push

  • Add migrations:

    python example/manage.py makemigrations two_factor
git commit two_factor/migrations -m "Added migrations"

  • Update translations:

    make tx-pull

  • Trigger the packaging and upload:

    git tag <tag number>
git push && git push --tags

The .github/workflows/release.yml file should do the remaining work and publish the release to PyPi.