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. (Guidelines TBD)

Git guidelines

Git commit messages should follow the Conventional Commits conventions. 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 in the file `CHANGELOG.md`.

Code guidelines

Check for Clippy lints by running cargo clippy and apply suggested changes, if any. If there is good reason not to apply a suggestion, add an #[allow(clippy::some_lint)] attribute to the smallest possible region (e.g. the function containing the offending code), along with a comment explaining your decision.

Ensure that all code has been formatted with Rustfmt before committing. This can be done by configuring your editor to autoformat on save or by running cargo fmt.

You can disallow local commits with clippy lints or formatting issues by creating a pre-commit hook. Create an executable file at .git/hooks/pre-commit with the following content:

#!/bin/sh

cargo clippy -- -Dwarnings
cargo fmt --check

Documentation guideines

Lint all Markdown documentation with markdownlint before committing.