CONTRIBUTING.md

How to contribute to this project

If you are interested in contributing to the development and maintenance of this package, it is recommended that you use poetry for dependency management and pyenv for python version management.

Environment

Clone the project

$ git clone https://gitlab.com/softbutterfly/open-source/django-sb-simple-migrations.git
$ cd django-sb-simple-migrations

Install the dependencies

$ poetry install

Testing and coverage

You can run the tests with poetry

poetry run pytest --cov --cov-report =
poetry run coverage report

In case you want to run the tests in all versions you can use [tox] (https://tox.readthedocs.io/en/latest/)

Do you want to send a PR?

Before making your first commit and submitting your pull request, run

bash
$ poetry run pre-commit install

Then do your commits on a regular basis.

Code of Conduct

Please note that this project is published with a Code of Conduct for collaborators. By participating in this project, you agree to abide by its terms.