1 How Do I Submit A Good Pull Request?

     2 ----------------------------------

     3 

     4 It's highly recommended to write nice and clean python code. Beremiz

     5 project tries to follows most of PEP-8 recommendations. They are

     6 automatically checked on every push and merge by Bitbucket pipelines.

     7 

     8 To avoid pushing "unclean" code, i's recommended to add one of the following

     9 commands to pre commit Mercurial hook into .hg/hgrc configuration file.

    10 

    11 ```

    12 [hooks]

    13 pretxncommit.linter = ./tests/tools/check_source.sh --only-changes

    14 ```

    15 or the same done using Docker container, so result will be the same as

    16 on Bitbucket pipeline.

    17 

    18 ```

    19 [hooks]

    20 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

    21 ```