Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.16 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as described in the project README, without any additional terms or conditions.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone the repository
  2. Make sure the tests pass on your machine: cargo test
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change, add tests, and make sure the tests still pass
  5. Push to your fork and submit a pull request
  6. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Use rustfmt to make sure your code automatically conforms to the standard Rust style guide.
  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Publishing a new version

If you are one of the maintainers of this package, bump the version numbers in Cargo.toml and README.md, then follow the typical instructions to publish a new version to crates.io:

cargo package
cargo publish

Resources