Skip to content
This repository was archived by the owner on Jun 21, 2022. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (74 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

122 lines (74 loc) · 2.92 KB

Contributing

Dev setup

To setup your dev env check the docs/dev.md.

Style guide

  • Double quotes are preffered ("), and for doc strings (""").
  • Use f-string format ("{}".format() or f"{}") instead of the %-format ("%s" % ()).

Some of the following tools are configured inside setup.cfg.

Editorconfig

There is also an editorconfig file .editorconfig that can be used with your IDE or text editor.

Black

Black is a Python code formatter.

black .

Flake8

flake8 is a Python code linter, it's used to verify coding errors and check style.

flake8 .

isort

isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type.

isort .

Pull requests & commits

Every pull request must contains only one commits, if not every commits must be squashed into a single one before potential merge.

All commits must use the imperative mood and respect the following format :

[lowercased imperative verb] [subject (what you did)] ([PR?if_it_fixes_a_PR]#[issue-number])

Examples

add HTTP error handling (#1392)

If it resolves multiples issues, the commit must contain every issues number inside the parentheses, only related issues must be included in the same commit/pull-request.

add IPFS deploy & logs view (#942, #943)

If it fixes something related to another pull request, the PR number inside the parentheses must be prefixed with "PR".

fix IPFS upload responsive view (PR#132)

Tools

Pre-commit

pre-commit is a git hook that will run before every commits. The pre-commit config can be found in .pre-commit-config.yaml.

To install the pre-commit use:

pre-commit install

To test it use:

pre-commit run --all-file

Tox

tox is a command line driven CI frontend and development task automation tool. It will launch multiple commands, check for format and lint the code and also run tests.

Run it with:

tox

Translations

Create / update .po files.

django-admin makemessages -l fr -i=venv

You can translate the content located in the /locale/<lang_code>/LC_MESSAGES/django.po file.

Then compile .po to .mo.

django-admin compilemessages -i=venv

Tests

If you add code don't forget to also write tests for it. For more informations about testing refer to the tests section from docs/dev.md.