aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-10 20:48:18 +0000
committerFuwn <[email protected]>2021-05-10 20:48:18 +0000
commitbd51d8a0f9f4c7b078523c4c6f544e107b760255 (patch)
treea9e83ff8dd19f9755f5d39316a41be69bdca9729
parentrefactor(utils): remove unused, outdated db util (diff)
downloadwhirl-bd51d8a0f9f4c7b078523c4c6f544e107b760255.tar.xz
whirl-bd51d8a0f9f4c7b078523c4c6f544e107b760255.zip
docs(contributing.md): add some contribution guidelines
Just some important things to follow when makes PRs. closes #21
-rw-r--r--CONTRIBUTING.md3
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.