From 0c27e2a01060a1ca67b6425982c42a994d532c84 Mon Sep 17 00:00:00 2001 From: Tatu Aalto Date: Fri, 27 May 2022 17:30:39 +0300 Subject: [PATCH] docs: add CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9327a96 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing +Project uses poetry and invoke to setup development environment. See [Poetry](https://python-poetry.org/) +documentation how to install Poetry in your operating system. Then use `poetry install` to +install required dependencies. + +Test can be run by: `poetry run invoke test +` +Bug fix or feature should be covered by tests and test(s) should be places in `utest` folder. Project uses +Python [pytest](https://docs.pytest.org) and is recommended to use plain functions in tests. + +Commit messages should use [Angular style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) +because project uses [Python semantic release](https://python-semantic-release.readthedocs.io/en/latest/index.html#) +package and commit message defines the next version number. More details about commit message format can be found from +[parsing commit logs](https://python-semantic-release.readthedocs.io/en/latest/commit-log-parsing.html#commit-log-parsing) + +# Release +Release is done automatically by a GitHub action. Release is triggered automatically with +[Python semantic release](https://python-semantic-release.readthedocs.io/en/latest/index.html#) and pushed out to PyPi +