Contributing¶

Thank you for considering contributing to Django Dispatch! This document outlines the process for contributing to the project.

Setting Up Development Environment¶

Clone your fork locally:

git clone https://github.com/mrb101/django-broadcaster.git
cd django-broadcaster

Create a virtual environment and install development dependencies:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

Create a branch for your changes:

git checkout -b feature/your-feature-name

Make your changes and write tests for them
Run the tests to ensure they pass:
```
pytest
```
Run the linters to ensure code quality:
```
flake8
black .
isort .
```
Commit your changes with a descriptive commit message:
```
git commit -m "Add feature X"
```

Push your changes to your fork:

git push origin feature/your-feature-name

To run the test suite:

pytest

To run tests with coverage:

pytest --cov=django_broadcaster

To build the documentation locally:

cd docs
make html

The built documentation will be in the _build/html directory.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

We expect all contributors to: