From 247bc6e48683f000052b06f154239055aeb07fda Mon Sep 17 00:00:00 2001 From: Kevin Petremann Date: Wed, 12 Jul 2023 15:28:51 +0200 Subject: [PATCH] docs: add contribution guide --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ed8423c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Developer guide + +## Requirements + +**unit or integrations tests** are mandatory. + +Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary). + +## Coding style + +Follow usual best practices: + * document your code + * one function = one purpose + * function name should perfectly define their purpose