Open project for contrib

Eve-ning · Sep 30, 2023 · 320edd7 · 320edd7
1 parent b84f113
commit 320edd7
Showing 1 changed file with 9 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,13 @@
 # Contributing
 
-This is still in the alpha stage, however, you're free to recommend functions to be implemented via Issues.
+## Getting Started
+
+You need `poetry` to get started. Install it via `pip install poetry`.
+
+Then, run `poetry install` to install all dependencies (in pyproject.toml).
+
+## Testing
+
+Run `poetry run pytest` to run all tests, or you can create a PR, GH Actions will run it for you.
 
-# Future
 
-After this is more stable, I'll open up contributions mainly in the algorithms' package, where you'll be able to implement
-functions for the community to use.