add CONTRIBUTING.org

Updates #37
go-critic · May 10, 2018 · 8b88c94 · 8b88c94
1 parent b12aea8
commit 8b88c94
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
@@ -0,0 +1,19 @@
+* Contributing to kfulint
+
+Here would be a set of guidelines that we follow when contributing to
+kfulint. You could propose changes in this document if you would like.
+
+** Accepted abbreviations
+    *LGTM* — looks good to me
+
+    *SGTM* — sounds good to me
+
+    *PTAL* — please take a look
+
+    *s/foo/bar/* — replace foo with bar; this is sed syntax
+
+    *s/foo/bar/g* — replace foo with bar throughout your entire change
+
+** How to write issues
+*** Issues naming guidelines
+*** How to choose correct label