Skip to content

Commit 819e7cc

Browse files
meatballsmarcharper
authored andcommitted
Add format instruction to contribution guidelines
1 parent 96fc4c7 commit 819e7cc

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/tutorials/contributing/guidelines.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,18 @@ The project follows the following guidelines:
1111
2. Try as best as possible to follow `PEP8
1212
<https://www.python.org/dev/peps/pep-0008/>`_ which includes **using
1313
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
1518
for anyone using git's log features. Try to use messages that complete sentence,
1619
"This commit will..." There is some excellent guidance on the subject
1720
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
1922
<https://docs.python.org/2/library/unittest.html>`_ library and has a nice
2023
testing suite that makes some things very easy to write tests for. Please try
2124
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
2326
maintainers to merge. Opening a PR for early
2427
feedback or to check test coverage is OK, just indicate that the PR is not ready
2528
to merge (and update when it is).

0 commit comments

Comments
 (0)