chore: Initial version.

This commit is contained in:
Elisiário Couto
2024-02-18 20:51:10 +00:00
parent 242ec6de5d
commit ec4f59e047
28 changed files with 1984 additions and 0 deletions

21
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,21 @@
# Contributing
Install Poetry and run `poetry install` to install dependencies. Then run `poetry shell` to activate the virtual environment.
Run `pre-commit install` to install the pre-commit hooks.
## Commit messages
type(scope/[subscope]): Title starting with uppercase and sentence ending with period.
More than 80 charactes use the body of the commit message.
Scope and subscopes are optional.
DO NOT use a bunch of different types: feat, fix, refactor should be more than enough.
## Release new version
Run script `scripts/release.sh <type_of_release>`
Types supported are `major`, `minor` and `patch`. Semver practices must be followed.
This release process deals with updating everything, including changelog generation.