Skip to content

Contributing

We Welcome Contributions!

Django Orbit is open source and we love contributions from the community.

How to Contribute

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a branch for your feature or fix
  4. Make your changes with tests
  5. Push to your fork
  6. Open a Pull Request

Development Setup

git clone https://github.com/astro-stack/django-orbit.git
cd django-orbit
python -m venv venv
source venv/bin/activate  # or .\venv\Scripts\activate on Windows
pip install -e ".[dev]"

Running Tests

pytest

Pull requests also run GitHub Actions CI on supported Python/Django combinations, release metadata, documentation builds, package builds and Twine metadata checks.

Before pushing a release PR, run the same local preflight used by maintainers:

python scripts/verify_release.py

For a quick metadata-only check:

python scripts/verify_release.py --metadata-only

Code Style

We use Black and isort for code formatting:

black orbit/
isort orbit/

Questions?

Thank you for contributing! 🚀