Contributing - robofit/arcor2 GitHub Wiki
- When making PR, please make sure to rebase your commits first or at least merge the last changes from
master
branch. - Ideally, PR should contain only one, clearly focused commit. If you have more commits, please squash them.
- We use Conventional Commits.
- We use type annotations and mypy. All code should have type annotations.
- If possible, please also add tests with any new code.
- If necessary, please do not forget to update also documentation.
- Before committing please run (all of those will run on CI but are much faster on localhost):
./pants fmt ::
to automatically format the code according to our rules../pants lint ::
to perform style checks (black, flake8, isort, docformatter)./pants check ::
to run mypy../pants test ::
to run tests (this may take a quite long time).
Any contribution is welcome!