From d50b1d3a1cbfe7f1df749f5635bdc983f97519d6 Mon Sep 17 00:00:00 2001 From: Malik Date: Fri, 2 Feb 2024 13:35:25 -0700 Subject: [PATCH] add format details and references --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 430922ca..1897c66c 100644 --- a/README.md +++ b/README.md @@ -250,6 +250,19 @@ options: follow `README.md` +## Formatting [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) + +Code formatting and import sorting are done automatically with `black` and `isort`. + +Fix imports and format : `pip install black isort; bash fixFormat.sh` + +Spelling is checked but not automatically fixed using `codespell` + + +## References + +Coming soon + ## Acknowledgments