Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (16 loc) · 721 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 721 Bytes

Contributing to Nimble

First off, thank you for considering contributing to Nimble!

Development Setup

  1. Prerequisites: Install the latest stable Rust toolchain.
  2. Clone the repo: git clone https://github.com/programmersd21/nimble.git
  3. Build: cargo build
  4. Test: cargo test

Style Guidelines

  • Follow standard Rust naming conventions (snake_case for functions, PascalCase for structs).
  • Run cargo fmt before committing.
  • Ensure cargo clippy returns no warnings.

Pull Request Process

  1. Create a feature branch from main.
  2. Add tests for any new functionality or bug fixes.
  3. Ensure the CI suite passes.
  4. Update documentation if necessary.