Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 1.93 KB
Raw

Contributing

Thank your for contributing to this project! We welcome collaborators and expect users to follow our code of conduct when submitting code or comments.

  1. Fork the repo.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Write tests that cover your work.
  4. Run Rustfmt, Clippy, and all tests to ensure CI rules are satisfied. Correct versions and feature flags can be found in the .travis.yml file.
  5. Commit your changes (git commit -am 'Add some feature').
  6. Push to your branch (git push origin my-new-feature).
  7. Create a new Pull Request.

General

  • We strive to follow the Rust API Guidelines to maintain consistency and compatibility in our code.

  • Commits should be one logical change that still allows all tests to pass. We prefer smaller commits if there could be two levels of logic grouping. The goal is to provide future contributors (including your future self) the reasoning behind your changes and allow them to cherry-pick, patch or port those changes in isolation to other branches or forks.

  • If during your PR you reveal a pre-existing bug and know how to fix it: 1. If you can isolate the bug, fix it in a separate PR. 2. If the fix depends on your other commits, add it in a separate commit to the same PR.

    In either case, try to write a regression test that fails because of the bug but passes with your fix.

Issues

Creating and discussing Issues provides significant value to the project. If you find a bug you can report it in an Issue.

Pull Requests (PR)

All pull requests should include:

  • A clear, readable description of the purpose of the PR
  • A clear, readable description of changes
  • Any additional concerns or comments (optional)