Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 2.23 KB

How to contribute

Dependencies

We use poetry to manage the dependencies.

To install them you would need to run install command:

poetry install

To activate your virtualenv run poetry shell.

Tests

We use pytest, flake8 and various pre-commit hooks for quality control.

To run all tests:

pytest

To run linting:

flake8 .

To update snapshots:

pytest --snapshot-update

These steps are mandatory during the CI.

For a fast feedback loop you can run the pre-commit hooks locally on all files via:

pre-commit run --all-files

Type checks

We use mypy to run type checks on our code. To use it:

mypy dump_env

This step is mandatory during the CI.

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 pytest 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 pytest again to make sure it is still working
  7. Run mypy to ensure that types are correct
  8. Run flake8 to ensure that style is correct
  9. Run doc8 to ensure that docs are correct

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.