Contributing

How to contribute

Dependencies

We use poetry to manage the dependencies.

To install them you would need to run install command:

poetry install --all-extras --all-groups

To activate your virtualenv run eval "$(poetry env activate)" or source .venv/bin/activate.

One magic command

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:

poetry 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 poetry run make -C docs clean html

Submitting your code

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

What the point of this method?

  1. We use protected master branch, so the only way to push your code is via pull request

  2. We use issue branches: to implement a new feature or to fix a bug create a new branch named issue-$TASKNUMBER

  3. Then create a pull request to master branch

  4. 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:

  1. Run make test to make sure everything was working before

  2. Add any changes you want

  3. Add tests for the new changes

  4. Edit documentation if you have changed something significant

  5. Update CHANGELOG.md with a quick summary of your changes

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

  1. Generate a .po file for your locale:

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

  2. Fill in the msgstr values in dmr/locale/<lang>/LC_MESSAGES/django.po

  3. Compile and validate all translations:

    make translations

  4. Commit both django.po and django.mo files

Improving an existing translation

  1. Edit dmr/locale/<lang>/LC_MESSAGES/django.po

  2. Compile and validate:

    make translations

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