Contributing

Contributors are very welcome! No contribution is too small and all contributions are valued.

Rust

You'll need to have the stable Rust toolchain installed in order to develop Managarr.

The Rust toolchain (stable) can be installed via rustup using the following command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

This will install rustup, rustc and cargo. For more information, refer to the official Rust installation documentation.

Commitizen

Commitizen is a nifty tool that helps us write better commit messages. It ensures that our commits have a consistent style and makes it easier to generate CHANGELOGS. Additionally, Commitizen is used to run pre-commit checks to enforce style constraints.

To install commitizen and the pre-commit prerequisite, run the following command:

python3 -m pip install commitizen pre-commit

Commitizen Quick Guide

To see an example commit to get an idea for the Commitizen style, run:

cz example

To see the allowed types of commits and their descriptions, run:

cz info

If you'd like to create a commit using Commitizen with an interactive prompt to help you get comfortable with the style, use:

cz commit

Setup workspace

Clone this repo
Run cargo test to setup hooks
Make changes
Run the application using make run or cargo run
Commit changes. This will trigger pre-commit hooks that will run format, test and lint. If there are errors or warnings from Clippy, please fix them.
Push your code to a new branch named after the feature/bug/etc. you're adding. This will trigger pre-push hooks that will run lint and test.
Create a PR

Questions? Reach out to me!

If you encounter any questions while developing Managarr, please don't hesitate to reach out to me at alex.j.tusa@gmail.com. I'm happy to help contributors, new and experienced in any way I can!

2.0 KiB Raw Blame History