feature: component works! concisely document guidelines

murilo-cunha · Nov 28, 2022 · 04125fb · 04125fb
1 parent 4254205
commit 04125fb
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing
+
+Thanks for your contribution! Some small points to consider before suggesting changes.
+
+We use `poetry` for packaging and environment management. Additionally, please use the `pre-commit` package and the hooks predefined. They ensure certain checks.
+
+```console
+git clone [email protected]:murilo-cunha/stream-wars.git
+cd stream-wars
+poetry shell
+poetry install
+pre-commit install
+```
+
+Thanks again for contributing! Feel free to open an issue if you have any questions/suggestions! 🚀