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 uv for dependency management and Python version management, along with poethepoet as the task runner.

🌍 Environment¶

Clone the project

git clone https://gitlab.com/softbutterfly/open-source/django-sb-adminplus.git
cd django-sb-adminplus

Install the dependencies

uv sync --all-groups

🧪 Testing and coverage¶

You can run the tests with poe:

uv run poe test

In case you want to run the tests in all versions you can use tox natively via our configured poe tasks:

uv run poe test:tox

🚀 Do you want to send a PR?¶

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

uv run pre-commit install --hook-type pre-commit --hook-type commit-msg

Then do your commits on a regular basis following the Conventional Commits specification.

🤝 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.