summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRubén Beltran del Río <ben@nsovocal.com>2018-06-26 22:00:10 +0000
committerRubén Beltran del Río <ben@nsovocal.com>2018-06-26 22:00:10 +0000
commitc80b2f4575cfc3d74ec8e0b112943cbd081ffcd7 (patch)
tree4d2c7a991fcc6510431af72225f7cea2c450f86a /CONTRIBUTING.md
parentbe12c97f83026087e0974fc54508b09c3154c9eb (diff)
parentfd38d4096e65ba5afba8ed1ddc75ed1814ca8c16 (diff)
Merge branch 'feature/rbdr-update-docs' into 'master'
Update Documentation See merge request rbdr/tomato-sauce!1
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
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