Skip to content

Commit 1e9b8f6

Browse files
Merge pull request #31 from paketb0te/update-contrib
Add section on code formatting in CONTRIBUTING.md
2 parents 9f00c9a + 7fc2caa commit 1e9b8f6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,12 @@ Since Git-Sim is a new project, we don't have an official code style set in
8383
stone. For now just try and make your new code fit in with the existing style
8484
you find in the codebase, and we'll update this section later if that changes.
8585

86+
## Code Formatting
87+
88+
This project uses the [`black`](https://github.com/psf/black) code formatter to keep all code in a constistent format.
89+
90+
Please install it in your development environment and run `black path/to/changed/files` before committing any changes.
91+
8692
## Commit conventions
8793

8894
We have a few simple rules for Git-Sim commit messages:

0 commit comments

Comments
 (0)