author | Andrey Skvortsov <andrej.skvortzov@gmail.com> |
Fri, 15 Jun 2018 16:41:55 +0300 | |
changeset 2186 | 2ec02f0f9fa9 |
parent 2185 | 439fc5d13c41 |
child 2241 | e762e234181d |
permissions | -rw-r--r-- |
2185
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
1 |
How Do I Submit A Good Pull Request? |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
2 |
---------------------------------- |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
3 |
|
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
4 |
It's highly recommended to write nice and clean python code. Beremiz |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
5 |
project tries to follows most of PEP-8 recommendations. They are |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
6 |
automatically checked on every push and merge by Bitbucket pipelines. |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
7 |
|
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
8 |
To avoid pushing "unclean" code, i's recommended to add one of the following |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
9 |
commands to pre commit Mercurial hook into .hg/hgrc configuration file. |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
10 |
|
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
11 |
``` |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
12 |
[hooks] |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
13 |
pretxncommit.linter = ./tests/tools/check_source.sh --only-changes |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
14 |
``` |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
15 |
or the same done using Docker container, so result will be the same as |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
16 |
on Bitbucket pipeline. |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
17 |
|
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
18 |
``` |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
19 |
[hooks] |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
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 |
439fc5d13c41
Add small contributing document with information about codestyle checking
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff
changeset
|
21 |
``` |