Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 2.7 KB
Raw

Contributing

All contributions are welcome! Besides code contributions, this includes things like documentation improvements, bug reports, and feature requests.

You should first check if there is a GitHub issue already open or related to what you would like to contribute. If there is, please comment on that issue to let others know you are working on it. If there is not, please open a new issue to discuss your contribution.

Not all contributions need to start with an issue, such as typo fixes in documentation or version bumps to Python or Django that require no internal code changes, but generally, it is a good idea to open an issue first.

We adhere to Django's Code of Conduct in all interactions and expect all contributors to do the same. Please read the Code of Conduct before contributing.

Setup

The following setup steps assume you are using a Unix-like operating system, such as Linux or macOS, and that you have a supported version of Python installed. If you are using Windows, you will need to adjust the commands accordingly. If you do not have Python installed, you can visit python.org for instructions on how to install it for your operating system.

  1. Fork the repository and clone it locally.
  2. Create a virtual environment and activate it. You can use whatever tool you prefer for this. Below is an example using the Python standard library's venv module:
python -m venv venv
source venv/bin/activate
  1. Install django-twc-toolbox and the dev dependencies in editable mode:
python -m pip install --editable '.[dev]'
# or using [just](#just)
just bootstrap

Testing

We use pytest for testing and nox to run the tests in multiple environments.

To run the test suite against the default versions of Python (lower bound of supported versions) and Django (lower bound of LTS versions), run:

python -m nox --session "test"
# or using [just](#just)
just test

To run the test suite against all supported versions of Python and Django, run:

python -m nox --session "tests"
# or using [just](#just)
just testall

just

just is a command runner that is used to run common commands, similar to make or invoke. A Justfile is provided at the base of the repository, which contains commands for common development tasks, such as running the test suite or linting.

To see a list of all available commands, ensure just is installed and run the following command at the base of the repository:

just