Contributing¶

How to contribute¶

Dependencies¶

We use uv to manage the dependencies.

To install them you would need to run sync command:

uv sync --all-extras --all-groups

venv¶

To activate your virtualenv run source .venv/bin/activate.

Compilation with mypyc, building a wheel¶

We also ship some optimized C-extensions together with our Python code. If you want to build them run:

make wheel

This will build dmr.compiled extensions with mypyc.

One magic command¶

After you installed the deps, run make test to run everything we have!

Tests¶

To run tests:

make unit

To run linting:

make lint

These steps are mandatory during the CI.

Documentation¶

To build docs locally:

uv run make -C docs clean html

If docs build fails on macOS with multiprocessing-related errors while running examples, force the start method explicitly:

DMR_SPAWN_METHOD=spawn uv run make -C docs clean html

Submitting your code¶

We use trunk based development (we also sometimes call it wemake-git-flow).

What is the point of this method?

We use protected master branch, so the only way to push your code is via pull request
We use issue branches: to implement a new feature or to fix a bug create a new branch named issue-$TASKNUMBER
Then create a pull request to master branch
We use git tags to make releases, so we can track what has changed since the latest release

So, this way we achieve an easy and scalable development process which frees us from merging hell and long-living branches.

In this method, the latest version of the app is always in the master branch.

Before submitting¶

Before submitting your code please do the following steps:

Run make test to make sure everything was working before
Add any changes you want
Add tests for the new changes
Edit documentation if you have changed something significant
Update CHANGELOG.md with a quick summary of your changes
Run make test again to make sure it is still working

Translations¶

We use Django’s built-in i18n system. Translation files live in dmr/locale/.

Contributing a new language¶

Generate a .po file for your locale:

uv run django-admin makemessages --locale <lang>

Fill in the msgstr values in dmr/locale/<lang>/LC_MESSAGES/django.po
Compile and validate all translations:
```
make translations
```
Commit both django.po and django.mo files

Improving an existing translation¶

Edit dmr/locale/<lang>/LC_MESSAGES/django.po
Compile and validate:
```
make translations
```
Commit both django.po and django.mo files

Other help¶

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.