aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan J. Martínez <jjm@usebox.net>2022-02-16 07:33:56 +0000
committerJuan J. Martínez <jjm@usebox.net>2022-02-16 07:33:56 +0000
commitb81f983e882ae947cc23f0bd074af36dca93f57e (patch)
tree2d17ccb4bad3c551208c46679134275fdfe5a0e2 /README.md
parent31418a90da67a1bcd1af0a39f33e8ecc5cdd2d49 (diff)
downloadubox-msx-lib-b81f983e882ae947cc23f0bd074af36dca93f57e.tar.gz
ubox-msx-lib-b81f983e882ae947cc23f0bd074af36dca93f57e.zip
Add black to CI
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 903184b..15e9863 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,15 @@ Some advice if you want to make a successful contribution:
- Get early feedback, specially when working on a large contribution
- Contributions always require a pull request and a review
+### Formatting
+
+This project uses [Black](https://github.com/psf/black) to format the Python
+code, and this is checked in CI.
+
+Before submitting any code to review, ensure you have installed Black 22.1.0 and run:
+
+ black .
+
## Authors
This was mostly written by Juan J. Martinez during the development of