Skip to content

Commit

Permalink
docs: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tatu Aalto committed May 27, 2022
1 parent 4384c4b commit 0c27e2a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 0c27e2a

Please sign in to comment.