aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMantas <mistermantas@users.noreply.github.com>2017-11-25 12:05:33 +0200
committerMantas <mistermantas@users.noreply.github.com>2017-11-25 12:05:33 +0200
commit3208df6352c0e05208bce95f8d9e9f16769a57ed (patch)
tree6d784f09fa6dc7d85438ca1086e32ba363d90483 /CONTRIBUTING.md
parent4bc818712d9b0133dd22326052a99ef1f36f4aa0 (diff)
cState goes stable 1.0; fix #4 & fix #5
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1675b87
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing Guide
+
+Thanks for taking the time to contribute. Folks like you are more than welcome!
+
+## I want to suggest something, report a bug, etc.
+
+Cool, [just create an issue](https://github.com/mistermantas/cstate/issues)!
+
+## I want to help contribute a new feature.
+
+Great. Here are some things to keep in mind:
+
++ Keep it as simple as possible.
++ Keep it as light as possible.
++ Try to make it readable.
+
+## Wait, my question has not been answered.
+
+At the time of writing, cState is such a small project that anyone contributing would be a downright miracle. However, if you are a miracle worker, please do redirect any concerns and they will addressed as soon as humanely possible. [Just create an issue](https://github.com/mistermantas/cstate/issues)!