Skip to content
This repository has been archived by the owner on Apr 27, 2024. It is now read-only.

Latest commit

 

History

History
30 lines (23 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.66 KB
Raw

Contributing to Cargo Geiger

The following is a set of guidelines for contributing to Cargo Geiger. Pull requests are very welcome, and the below are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.

Contribution Workflow

Cargo Geiger uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes to Cargo Geiger:

  1. Within your fork of Cargo Geiger, create a branch for your contribution. Use a meaningful name.
  2. Make your changes.
  3. Create a pull request against the master branch of the Cargo Geiger repository.
  4. Once the pull request is approved, one of the maintainers will merge it.

Contribution Quality Standards

Some of the below quality and style standards will be enforced automatically by the CI/CD pipeline:

  • Separate each logical change into its own commit.
  • Each commit must pass all unit & code style tests.
  • Unit test coverage should increase the overall coverage of the project.
  • Integration test cases should be added for any new functionality added in your pull request.
  • All public functions should be documented using Rust Documentation
  • Add a descriptive message for each commit. Follow commit message best practices.
  • Recommendations from cargo clippy should be applied.
  • All code should be formatted by cargo fmt.
  • Pull requests should be documented, explaining why the pull request was raised.