Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.17 KB

How to contribute

Thanks for reading this document!

Prerequisites

  • Rust (e.g. via rustup install stable)
  • Cargo (with fmt, clippy and nextest):
    • rustup component add rustfmt
    • rustup component add clippy
    • cargo install cargo-nextest

Code style

Before you create a PR, just run check.sh:

  • This will format your code via fmt
  • Runs the linter clippy
  • Runs all tests via nextest

Good first issues

If you want to contribute, but don't feel ready for the big tasks, feel free to choose from one of our good first issues

Guides

If you're lost or not know how to start, you can contact:

  • @rawkode
  • @icepuma
  • @martintc

at the Rawkode Academy Discord in the #comtrya channel.

Pull requests

We provide a pull request template to guide you through the progress.

Help

If you want to get in touch with us, join the Rawkode Academy Discord server and jump into the #comtrya channel.

See You Space Cowboy...