Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

83 lines (56 loc) · 1.78 KB
Raw

Contribution guidelines

First off, thank you for considering contributing to carrot-cake.

If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.

Reporting issues

Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.

Pull requests

Try to do one pull request per change.

Updating the changelog

Update the changes you have made in CHANGELOG file under the Unreleased section.

Add the changes of your pull request to one of the following subsections, depending on the types of changes defined by Keep a changelog:

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

If the required subsection does not exist yet under Unreleased, create it!

Developing

Set up

This is no different than other Rust projects.

git clone https://github.com/truelayer/carrot-cake
cd carrot-cake
cargo test

Useful Commands

  • Build and run release version:
cargo build --release && cargo run --release
  • Run Clippy:
cargo clippy --all-targets --all-features --workspace
  • Run all tests:

(requires docker)

./scripts/init_rabbitmq.sh
cargo test --all-features --workspace
  • Check to see if there are code formatting issues
cargo fmt --all -- --check
  • Format the code in the project
cargo fmt --all