]> git.lizzy.rs Git - nothing.git/commitdiff
(#340) Add Contributing Rules
authorrexim <reximkut@gmail.com>
Mon, 17 Sep 2018 18:20:06 +0000 (01:20 +0700)
committerrexim <reximkut@gmail.com>
Mon, 17 Sep 2018 18:21:29 +0000 (01:21 +0700)
CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..fafd518
--- /dev/null
@@ -0,0 +1,24 @@
+# Issues
+
+- Feel free to submit an issues in case of
+  - bug
+  - suggestion
+  - feature request
+  - question regarding the project
+  - unclear documentation
+  - unreadable or straight up bad code
+  - any problem that you ran into while setting up the project on your side
+- Do not submit **Tasks**. Submit **Problems**.
+  - Bad issue: "Rewrite everything in Rust"
+  - Good issue: "Using C makes the development difficult"
+  - We are engineers. We don't follow anybody's direction. We solve problems. Please submit problems.
+
+# Pull Requests
+
+- Keep your PRs nice and small around 300 changes. PRs that are way over that threshold won't be merged.
+  - If 300 changes is not enough,
+    - make as many changes as you can according to the PR size limitation,
+    - make sure that the code is compilable and the application is usable,
+    - create TODOs right in the code for the unfinished work,
+    - submit PR with the unfinished work and TODOs,
+    - TODOs will be converted to separate issues