Decisions
This file contains all the decisions made by the core team for the whole project. They are just recommendations.
Editor / IDE
The recommended editor is Visual Studio Code or Neovim.
Version control system
The recommended version control system is Git on GitHub. Pre-commit is highly recommended. There will be no forks on GitLab, Bitbucket or any other version control system.
Commit format
Commits should be formatted in the conventional commit format starting with v1.0.0-alpha.4.
Documentation
The recommended documentation system is mkdocs with the mkdocs-material theme, deploying to readthedocs.
Release versioning
The versioning scheme is Semantic Versioning 2.0 and the changelog scheme is Keep a changelog 1.1.
Linter
The recommended linter is megalinter (CI), in combination with clippy. This linter will be executed automatically when using pre-commit. All linters are included in megalinter.
Code formatter
The recommended code formatters are fmt and prettier, as well as black for python code.
Todo comments
The recommended Todo comments scheme is following:
| Text Only | |
|---|---|