Add how to contribute to the project

hugoledoux · Mar 6, 2024 · 778ce69 · 778ce69
1 parent c7401fb
commit 778ce69
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Contributing
+
++ The GitHub Issues section is the primary communication channel, please post issues, questions, feature requests there.
+
++ The repository follows the [Gitflow branching model](http://nvie.com/posts/a-successful-git-branching-model/).
+
++ To contribute **documentation** consider extending, fixing or adjusting the `/docs` and submit a pull request.
+
+
++ To contribute **code**, please submit a pull request. Notice that some functions are coded in the [Rust library startin](https://github.com/hugoledoux/startin/), so consider opening an issue/PR there is needed.