File tree Expand file tree Collapse file tree 1 file changed +6
-3
lines changed
docs/tutorials/contributing Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -11,15 +11,18 @@ The project follows the following guidelines:
11
11
2. Try as best as possible to follow `PEP8
12
12
<https://www.python.org/dev/peps/pep-0008/> `_ which includes **using
13
13
descriptive variable names **.
14
- 3. Commits: Please try to use commit messages that give a meaningful history
14
+ 3. Code Format: Use the `Black formatter <https://github.com/ambv/black >`_ to format
15
+ all code and the `isort utility <https://github.com/timothycrosley/isort >`_ to
16
+ sort import statements.
17
+ 4. Commits: Please try to use commit messages that give a meaningful history
15
18
for anyone using git's log features. Try to use messages that complete sentence,
16
19
"This commit will..." There is some excellent guidance on the subject
17
20
from `Chris Beams <https://chris.beams.io/posts/git-commit/ >`_
18
- 4 . Testing: the project uses the `unittest
21
+ 5 . Testing: the project uses the `unittest
19
22
<https://docs.python.org/2/library/unittest.html> `_ library and has a nice
20
23
testing suite that makes some things very easy to write tests for. Please try
21
24
to increase the test coverage on pull requests.
22
- 5 . Merging pull-requests: We require two of the (currently three) core-team
25
+ 6 . Merging pull-requests: We require two of the (currently three) core-team
23
26
maintainers to merge. Opening a PR for early
24
27
feedback or to check test coverage is OK, just indicate that the PR is not ready
25
28
to merge (and update when it is).
You can’t perform that action at this time.
0 commit comments