From 095fd607abfac242a304ebab50a24ba40d161c4c Mon Sep 17 00:00:00 2001 From: Manuel Stausberg Date: Fri, 27 Jan 2023 10:49:17 +0100 Subject: [PATCH 1/2] add section on code formatting --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cfba64..eb7b9a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: From 7fc2caa57c9f8dd90b4c8add0db70ed7c73dd734 Mon Sep 17 00:00:00 2001 From: Jacob Stopak <49353917+initialcommit-io@users.noreply.github.com> Date: Fri, 27 Jan 2023 02:07:51 -0800 Subject: [PATCH 2/2] Fix minor text inconsistencies --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb7b9a0..ccd13ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,11 +83,11 @@ 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 +## 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. +Please install it in your development environment and run `black path/to/changed/files` before committing any changes. ## Commit conventions