From 04125fb02860bd8e53e2f713353a3677f05db4f2 Mon Sep 17 00:00:00 2001 From: Murilo Cunha Date: Mon, 28 Nov 2022 21:08:59 +0100 Subject: [PATCH] feature: component works! concisely document guidelines --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..caef8d7 --- /dev/null +++ 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 git@github.com: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! 🚀