Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 812 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 812 Bytes
Raw

Contributing

Thanks for contributing!

Getting Started

Making Changes

  • After making changes, be sure to run the tests (see below)!
  • Add an entry to the CHANGELOG
  • This crate makes use of cargo-readme (cargo install cargo-readme) to generate the README.md from the crate level documentation in src/lib.rs. This means README.md should never be modified by hand. Changes should be made to the crate documentation in src/lib.rs and the readme.sh script run.

Running Tests

cargo test

Submitting Changes

Pull Requests should be made against master. Travis CI will run the test suite on all PRs. Remember to update the changelog!