Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 782 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 782 Bytes
Raw

Contributing to vergen

  1. Ensure you have cargo-clippy and rustfmt installed. These can be installed via rustup if you don't already have them.

  2. Fork the repository

  3. Run the following to clone and setup the repository. There are submodules in the testdata directory used for testing specific git scenarios

    git clone [email protected]:<your fork>/vergen.git
cd vergen.git
git submodule update --init

  4. Install cargo-all-features

    cargo install cargo-all-features

  5. Make your changes

  6. Before submitting a PR, make sure you have at least run the following

    cargo fmt
cargo clippy --all
cargo build-all-features
cargo test-all-features

  7. Push your changes to your fork and submit a PR.