Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.57 KB

Contributing to the project

This project is open-source and contributions are welcome. If you want to contribute, please follow the guidelines below.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Submitting an issue

When reporting an issue, please include the following information:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the issue.
  • Expected
  • Actual
  • Environment information (OS, rust version, etc.)

Submitting a feature request

When submitting a feature request, please include the following information:

  • A clear and descriptive title.
  • A detailed description of the feature.
  • Use cases for the feature.
  • Any additional information that might be useful.

Pull requests

When submitting a pull request, please follow these guidelines:

  • Fork the repository and create a new branch.
  • Make sure your code is formatted with cargo fmt.
  • Make sure your code passes the tests with cargo test.
  • Make sure your code passes the linter with cargo clippy.
  • Make sure your code is documented.

License

This project is licensed under the MIT license. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.