diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..168963d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note this project follows the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct), please follow it in all your interactions with the project. + +## Pull Request Process + +1. You must ensure the changes do not cause any warnings with our linters, follow our + formatting guidelines (formatting can be automatically done with `cargo fmt`) and all changes + pass existing and new tests. +2. You must ensure the changes fully resolve the related issue and all added functionality is tested. +3. You may merge the Pull Request in once you have the sign-off of atleast one other developer, or if you + do not have permission to do that, you may request the reviewer to merge it for you. |