The branching model of this project is based on the git-flow.
Please see the Commit messages guide.
-
Create a working branch from the
develop
branch. The branch name should be something other thandevelop
ormaster
. -
Create your patch. If your change is a feature or a bugfix, please add a test case if possible. Note that the change must pass the CI.
-
Please update the copyright information if possible. This project is compliant with version 3.0 of the REUSE Specification.
reuse
is useful for updating the copyright information. -
Please update the Changelog if possible.
-
Please read and agree to follow the Code of Conduct.
The just command runner can be used. Run
just --list
for more details.
Run tests
just test
Run the formatter
just fmt
Run the linter
just lint