diff options
| author | Fuwn <[email protected]> | 2021-05-10 20:48:18 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-05-10 20:48:18 -0700 |
| commit | a6204ce8fda61cf0c06d2d98923a581db1baf286 (patch) | |
| tree | a18172c281d8c8e9636f06f3d541d840286d65f8 | |
| parent | refactor(utils): remove unused, outdated db util (diff) | |
| download | whirl-a6204ce8fda61cf0c06d2d98923a581db1baf286.tar.xz whirl-a6204ce8fda61cf0c06d2d98923a581db1baf286.zip | |
docs(contributing.md): add some contribution guidelines
Just some important things to follow when makes PRs.
closes #21
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 794f9bc..a9052f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,4 +2,5 @@ This document isn't very well detailed at the moment... ## Guidelines -1. At the moment, there is no GitHub Action in place to check if your pull request will compile, please ensure that your changes **do** in-fact compile before submitting your pull request (s). +1. Make sure your PR compiles. If the GitHub action "Rust ✅/ 🚫" fails, your PR will be declined. +2. Make sure your commit changes something other than just formatting. |