Contribution Guide
Thank you for your interest in contributing to this project! If you would like to contribute to this project, please follow the instructions below if possible.
Branching model
The branching model of this project is based on the git-flow.
Style guides
Commit message
Please see the Commit messages guide and the Conventional Commits.
Submitting a pull request
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.2 of the REUSE Specification.
reuse
is useful for updating the copyright information.Please update the following applicable Changelog if possible.
Please read and agree to follow the Code of Conduct.
Development
Useful development tools
The just command runner can be used. Run
just --list
for more details.
just test
just fmt
just lint