Skip to content

add section on code formatting in CONTRIBUTING.md #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 27, 2023
Merged

add section on code formatting in CONTRIBUTING.md #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
095fd60
add section on code formatting
paketb0te Jan 27, 2023
7fc2caa
Fix minor text inconsistencies
initialcommit-io Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ Since Git-Sim is a new project, we don't have an official code style set in
stone. For now just try and make your new code fit in with the existing style
you find in the codebase, and we'll update this section later if that changes.

## Code Formatting

This project uses the [`black`](https://github.com/psf/black) code formatter to keep all code in a constistent format.

Please install it in your development environment and run `black path/to/changed/files` before committing any changes.

## Commit conventions

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