jabara Wiki - User contributions [en]

Contribution guidelines

2026-04-03T00:07:37Z

Peri: Add clippy to code guidelines.

This page contains guidelines for contributing code to [[jabara]].

== Source access ==
jabara is developed on a dedicated [https://forgejo.org Forgejo] instance hosted at [https://git.zelda.sr git.zelda.sr]. The primary repository is located under the [https://git.zelda.sr/jabara jabara] organization at [https://git.zelda.sr/jabara/jabara 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 [https://www.conventionalcommits.org/en/v1.0.0/ Conventional Commits] conventions. Here are a few well-formed examples:

* <code>chore: flatten imports and re-export `Cpu`</code>
* <code>fix(docs): use `align` instead of `style`</code>

After the first release, changelogs will be kept as described by [https://keepachangelog.com/en/1.1.0/ Keep a Changelog].

== Code guidelines ==

Check for [https://doc.rust-lang.org/stable/clippy/index.html Clippy] lints by running <code>cargo clippy</code>, and apply suggested changes, if any. If there is a good reason not to apply Clippy's suggestion, add an <code>#[allow(clippy::some_lint)]</code> 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 [https://rust-lang.github.io/rustfmt/ Rustfmt] before committing. This can be done by configuring your editor to autoformat on save or by running <code>cargo fmt</code>.

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

cargo clippy -- -Dwarnings
cargo fmt --check
</pre>

Contribution guidelines

2026-03-24T19:26:08Z

Peri: add initial guidelines

This page contains guidelines for contributing code to [[Jabara]].

== Source access ==
jabara is developed on a dedicated [https://forgejo.org Forgejo] instance hosted at [https://git.zelda.sr git.zelda.sr]. The primary repository is located under the jabara organization at [https://git.zelda.sr/jabara/jabara jabara/jabara]

== Submitting changes ==
Contributions to jabara should be made as pull requests to the [https://git.zelda.sr/jabara/jabara repository].
(TBA more PR guidelines when this becomes relevant)

== Git guidelines ==
Git commit messages should be formatted as described by [https://www.conventionalcommits.org/en/v1.0.0/ Conventional Commits]. Here are a few well-formed examples:<br>

<code>chore: flatten imports and re-export `Cpu`</code><br>

<code>fix(docs): use `align` instead of `style`</code><br>

After the first release, changelogs will be kept as described by [https://keepachangelog.com/en/1.1.0/ 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 <code>cargo fmt</code>.

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

cargo fmt --check
</pre>

User:Peri

2026-03-24T17:47:12Z

Peri: added :3

[[File:33.webp|thumb|Colon Three]]

File:33.webp

2026-03-24T17:46:16Z

Peri: