Contributing

July 28, 2026 · View on GitHub

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Scope

The goal of this project is to seamlessly blend Django and Bootstrap 5: template tags and widgets that render Bootstrap 5 markup for Django forms. Contributions that fit that goal are welcome. Contributions that don't (such as a competing form-rendering abstraction, support for other CSS frameworks, functionality unrelated to rendering Django forms as Bootstrap 5) are likely to be closed even if well-implemented, so it's worth opening an issue to discuss scope before investing time in a pull request.

Types of Contributions

Report Bugs

Report bugs at https://github.com/zostera/django-bootstrap5/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

django-bootstrap5 could always use more documentation, whether as part of the official django-bootstrap5 docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/zostera/django-bootstrap5/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Get Started!

Ready to contribute? Here's how to set up django-bootstrap5 for local development.

You will need some knowledge of git, github, and Python/Django development. Using a Python virtual environment is advised.

Local installation

This package uses uv and just.

After installing both, check out this repository and type just install to bootstrap a development environment.

git clone git://github.com/zostera/django-bootstrap5.git
cd django-bootstrap5
just install

Running the tests

To run the tests:

just test

To run the tests on all supported Python/Django combinations:

just tests

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. It fits the project's scope — if in doubt, open an issue first.
  2. It includes tests for new or changed functionality, and passes all existing tests (just test).
  3. It doesn't change the rendered markup or DOM structure of an existing widget or tag unless that's the explicit point of the PR — existing users depend on the current output.
  4. New settings or {% bootstrap_* %} keyword arguments follow existing naming conventions — in particular, a setting shares its name with the kwarg it defaults (e.g. wrapper_class is both the kwarg and the BOOTSTRAP5 setting key), not a default_-prefixed variant.
  5. It doesn't add a new runtime dependency without discussing it in an issue first.
  6. If it adds functionality, the docs are updated and the change is added to CHANGELOG.md.

Pull requests that don't meet these may be asked for changes, or closed if they've gone stale without a response — see MAINTAINING.md for how the project handles review backlog and version support.