From d4bd5ee92b67fea1eee60f916ab493b9aba3fe09 Mon Sep 17 00:00:00 2001 From: Markus Opolka Date: Fri, 12 May 2023 17:10:36 +0200 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5be4628 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing +Before starting your work on this module, you should [fork the project] to your GitHub account. This allows you to +freely experiment with your changes. When your changes are complete, submit a [pull request]. All pull requests will be +reviewed and merged if they suit some general guidelines: + +* Changes are located in a topic branch +* For new functionality, proper tests are written +* Changes should not solve certain problems on special environments + +## Branches +Choosing a proper name for a branch helps us identify its purpose and possibly find an associated bug or feature. +Generally a branch name should include a topic such as `fix` or `feature` followed by a description and an issue number +if applicable. Branches should have only changes relevant to a specific issue. + +``` +git checkout -b fix/service-template-typo-1234 +git checkout -b feature/config-handling-1235 +git checkout -b doc/fix-typo-1236 +``` + +## Testing +Python modules are unit tested with the Python Standard Library. When modifying existing modules or tasks, make sure all existing tests pass. If you add new functionality, make sure to write appropriate tests as well. + +[fork the project]: https://help.github.com/articles/fork-a-repo/ +[pull request]: https://help.github.com/articles/using-pull-requests/