CONTRIBUTING.md
author Andrey Skvortsov <andrej.skvortzov@gmail.com>
Fri, 29 Jun 2018 15:36:34 +0300
changeset 2239 813792f22527
parent 2185 439fc5d13c41
child 2241 e762e234181d
permissions -rw-r--r--
Make information about translation to be in unicode

This is necessary because some translator's names contains non-ASCII
characters and they are not handled properly in about dialog on Windows
How Do I Submit A Good Pull Request?
----------------------------------

It's highly recommended to write nice and clean python code. Beremiz
project tries to follows most of PEP-8 recommendations. They are
automatically checked on every push and merge by Bitbucket pipelines.

To avoid pushing "unclean" code, i's recommended to add one of the following
commands to pre commit Mercurial hook into .hg/hgrc configuration file.

```
[hooks]
pretxncommit.linter = ./tests/tools/check_source.sh --only-changes
```
or the same done using Docker container, so result will be the same as
on Bitbucket pipeline.

```
[hooks]
pretxncommit.linter = hg status -m -n -a -n -I '**.py' --change $HG_NODE > files.lst && docker run --volume=$PWD:/beremiz --workdir="/beremiz" --volume=$PWD/../CanFestival-3:/CanFestival-3 --memory=1g --entrypoint=/beremiz/tests/tools/check_source.sh skvorl/beremiz-requirements --files-to-check files.lst
```