- The next month of sprint planning can always be found on our github kanban board
- PRs should be made against the
mainbranch in the saito-rust project - PRs must pass rust fmt (via Github Actions) check and should have full test coverage
- Convo
To check your commits according to the format it can be installed locally
We use Conventional Commits for commit messages.
In short a commit message should follow this format:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
For example:
feat(keypair): add format check
- For the full specification please have a look at https://www.conventionalcommits.org
- Reasons to use this format can be found in this post: https://marcodenisi.dev/en/blog/why-you-should-use-conventional-commits
Most used types:
fixfeat
Further recommended types:
buildchorecidocsstylerefactorperftest
If the commit relates to an issue the issue number can be added to the commit-descrition or -body, i.e.:
feat(keypair): add format check #123