From a6204ce8fda61cf0c06d2d98923a581db1baf286 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Mon, 10 May 2021 20:48:18 -0700 Subject: docs(contributing.md): add some contribution guidelines Just some important things to follow when makes PRs. closes #21 --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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. -- cgit v1.2.3