website: Segregate C/C++ and Python coding styles
We now recommend using Black for automated styling of Python files. This
commit adds this recommendation and labels the older style guide as
being for C/C++ exclusively.
Change-Id: Id42cd3b512288da334164e4491ce49f6db40f404
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-website/+/62113
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
diff --git a/_pages/contributing.md b/_pages/contributing.md
index 0cb3a25..a875c4e 100644
--- a/_pages/contributing.md
+++ b/_pages/contributing.md
@@ -79,9 +79,11 @@
## Making modifications
+### C/CPP
+
Different tasks will require the project to be modified in different ways.
-Though, in all cases, our style-guide must be adhered to. The full style guide
-is outlined [here](/documentation/general_docs/development/coding_style).
+Though, in all cases, our style-guide must be adhered to. The full C/C++ style
+guide is outlined [here](/documentation/general_docs/development/coding_style).
As a high-level overview:
@@ -139,6 +141,28 @@
}
```
+### Python
+
+We use [Python Black](https://github.com/psf/black) to format our Python code
+to the correct style. To install:
+
+```sh
+pip install black
+```
+
+Then run on modified/added python files using:
+
+```sh
+black <files/directories>
+```
+
+For varibale/method/etc. naming conventions, please follow the [PEP 8 naming
+convention recommendations](
+https://peps.python.org/pep-0008/#naming-conventions). While we try our best to
+enforce naming conventions across the gem5 project, we are aware there are
+instances where they are not. In such cases please **follow the convention
+of the code you are modifying**.
+
### Using pre-commit
To help enforce our style guide we use use [pre-commit](
