Add contribution guidelines and instructions for Linux setup

washcycle · Dec 19, 2023 · dcb3e0d · dcb3e0d
1 parent db37806
commit dcb3e0d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,11 @@
 # Contribute
 
+- Pull requests welcome
+- Before pull requests run
+  - `black src`
+  - `isort src`
+  - Use https://www.conventionalcommits.org/en/v1.0.0/ for tagging commits and pull requests to the best of your ability.
+
 ## Linux
 - Install python 3.10 from here [here](https://www.python.org/downloads/).
 - `python3.10 -m venv ~/.venvs/poetry`