Update Documentation

[rbdr/tomato-sauce] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..81079cb
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing to Tomato Sauce
+
+This project doesn't really have much of a roadmap other than making
+more screens. If you have any new screens or would like to make
+improvements please feel free to submit changes.
+
+## The objective of Tomato Sauce
+
+Render pretty things using telnet
+
+## How to contribute
+
+Above All: Be nice, always.
+
+* Ensure the linter shows no warnings or errors
+* Don't break the CI
+* Make the PRs according to [Git Flow][gitflow]: (features go to
+  develop, hotfixes go to master)
+
+[gitflow]: https://github.com/nvie/gitflow