From 778ce69a1c862f16f34c615b30f8f01a79fedc8c Mon Sep 17 00:00:00 2001 From: Hugo Ledoux Date: Wed, 6 Mar 2024 10:29:10 +0100 Subject: [PATCH] Add how to contribute to the project --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..977c454 --- /dev/null +++ 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.