Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.72 KB

Contributing to this Project

Getting Started

Open issues are here. An easy way to get started helping the project is to file an issue. You can do this by creating an issue here. Issues can include bugs to fix, features to add, or documentation that looks outdated.

For some tips on contributing to open source, this post is helpful.

Contributions

I welcome contributions from everyone.

Contributions to this project should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required.

Pull Request Checklist

  • Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.

  • Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.

  • Add tests relevant to the fixed bug or new feature.

  • Fix sonar issues

Conduct

We follow the Rust Code of Conduct.

All code in this repository is under the Apache Software Foundation License, 2.0.