Contribution guidelines

This page contains guidelines for contributing code to Jabara.

Source access

jabara is developed on a dedicated Forgejo instance hosted at git.zelda.sr. The primary repository is located under the jabara organization at jabara/jabara

Submitting changes

Contributions to jabara should be made as pull requests to the repository. (TBA more PR guidelines when this becomes relevant)

Git guidelines

Git commit messages should be formatted as described by Conventional Commits. Here are a few well-formed examples:

chore: flatten imports and re-export `Cpu`

fix(docs): use `align` instead of `style`

After the first release, changelogs will be kept as described by Keep a Changelog.

Code guidelines

Ensure that all code has been formatted with rustfmt before committing. This can be accomplished through configuring your editor to autoformat on save, or running cargo fmt.

You can disallow local commits with formatting issues by creating a pre-commit hook (create an executable file at .git/hooks/pre-commit) with this content:

#!/bin/sh

cargo fmt --check