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

  1. Create a working branch from the develop branch. The branch name should be something other than develop or master.

  2. 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.

  3. 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.

  4. Please update the Changelog if possible.

  5. 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.

Run tests
just test
Run the formatter
just fmt
Run the linter
just lint