Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (41 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

53 lines (41 loc) · 2.3 KB

Contributing

Get Started

This is a Rust project, so rustup is a great place to start. It provides an easy way to manage your Rust installation and toolchains.

This is a pure Rust project, so only cargo is needed. Here are some common commands to get you started:

  • cargo check: Analyze the current package and report errors.
  • cargo fmt: Format the current code according to the Rust style guidelines.
  • cargo build: Compile the current package.
  • cargo clippy: Catch common mistakes and improve code quality.
  • cargo test: Run unit tests.
  • cargo bench: Run benchmark tests.

Setting up the Development Environment

  1. Install Rust using rustup. Follow the instructions on the rustup website to install Rust on your system.
  2. Clone the repository to your local machine.
  3. Navigate to the project directory.

Making Changes

  1. Create a new branch for your changes.
  2. Make your changes and ensure that the code still compiles and passes all tests.
  3. Format your code using cargo fmt to ensure consistency with the project's code style.

Submitting Changes

  1. Once you are satisfied with your changes, push your branch to the remote repository.
  2. Open a pull request on the project's GitHub page. Provide a clear description of your changes and why they are necessary.
  3. Wait for reviews and address any feedback. Once the pull request is approved and merged, your changes will be part of the project.

Thank you for contributing to this project!