Contribution guidelines: Difference between revisions
add initial guidelines |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This page contains guidelines for contributing code to [[ | This page contains guidelines for contributing code to [[jabara]]. | ||
== Source access == | == 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] | 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 == | == Submitting changes == | ||
Contributions to jabara should be made as pull requests to the | Contributions to jabara should be made as pull requests to the repository. (Guidelines TBD) | ||
( | |||
== Git guidelines == | == Git guidelines == | ||
Git commit messages should | 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>chore: flatten imports and re-export `Cpu`</code> | ||
* <code>fix(docs): use `align` instead of `style`</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]. | After the first release, changelogs will be kept as described by [https://keepachangelog.com/en/1.1.0/ Keep a Changelog]. | ||
== Code guidelines == | == Code guidelines == | ||
Ensure that all code has been formatted with rustfmt before committing. This can be | 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 formatting issues by creating a pre-commit hook | 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 the following content: | ||
<pre> | <pre>#!/bin/sh | ||
#!/bin/sh | |||
cargo fmt --check | cargo fmt --check</pre> | ||
</pre> | |||
Revision as of 07:47, 25 March 2026
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.
Code guidelines
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 formatting issues by creating a pre-commit hook. Create an executable file at .git/hooks/pre-commit with the following content:
#!/bin/sh cargo fmt --check