Adds pre-commit instructions to Readme

FAIRmat-NFDI · Dec 2, 2024 · b3b1e21 · b3b1e21
1 parent 412c69b
commit b3b1e21
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,14 @@ To integrate this plugin with your NOMAD installation:
 
 2. For more detailed installation instructions, visit our [docs for NOMAD plugins](https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html).
 
+## Developers
+
+It's nice to not miss a ruff fromat before pushing your commits. To set up pre-commit hook:
+```console
+   pip install pre-commit
+   pre-commit install
+```
+
 ### Acknowledgments
 Special thanks to Jinzhao Li and all contributors who have made this project possible.