From 98837d52ba06b4c84e76bb77ccfb6929611ae499 Mon Sep 17 00:00:00 2001
From: Daniel <57721552+dluo96@users.noreply.github.com>
Date: Mon, 14 Nov 2022 10:05:28 +0000
Subject: [PATCH] docs: state that we use the google style guide (#42)

---
 CONTRIBUTING.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index da6b9dd06..ed70cbc70 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -39,13 +39,15 @@ When contributing a new environment, make sure to do the following:
 
 
 ### Coding Style
-To guarantee the quality and uniformisation of the code, we use various linters:
+In general, we follow the [Google Style Guide](https://google.github.io/styleguide/pyguide.html).
+In addition, to guarantee the quality and uniformity of the code, we use various linters:
 
 - [Black](https://black.readthedocs.io/en/stable/#) is a deterministic code formatter that is compliant with PEP8 standards.
 - [Isort](https://pycqa.github.io/isort/) sorts imports alphabetically and separates them into sections.
 - [Flake8](https://flake8.pycqa.org/en/latest/) is a library that wraps PyFlakes and PyCodeStyle. It is a great toolkit for checking your codebase against coding style (PEP8), programming, and syntax errors. Flake8 also benefits from an ecosystem of plugins developed by the community that extend its capabilities. You can read more about Flake8 plugins on the documentation and find a curated list of plugins here.
 - [MyPy](https://mypy.readthedocs.io/en/stable/#) is a static type checker that can help you detect inconsistent typing of variables.
 
+
 #### Pre-Commit
 To help in automating the quality of the code, we use [pre-commit](https://pre-commit.com/), a framework that manages the installation and execution of git hooks that will be run before every commit. These hooks help to automatically point out issues in code such as formatting mistakes, unused variables, trailing whitespace, debug statements, etc. By pointing these issues out before code review, it allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks. Each commit should be preceded by a call to pre-commit to ensure code quality and formatting. The configuration is in .pre-commit-config.yaml and includes Black, Flake8, MyPy and checks for the yaml formatting, trimming trailing whitespace, etc.
 Try running: `pre-commit run --all-files`. All linters must pass before committing your change.