Merge branch 'contribution-guide' into 'master'

Resolve "Contribution Guide"

Closes #26

See merge request aic18/G6T4!19

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d3a65477d27b182c36b7bdb097c74330c60b1856..ee52a52b40d5ba5d496fb11a543ecc4e744de1f1 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,16 @@
 # Contribution Guide
 
-TODO
+
+## Guidelines
+
+* Don't push directly to the `master` branch.
+* Create a new branch from `master` for new features. For best pratice, prefix it with the name of your service, e.g. `twitter-fix-something`.
+* Use Merge Requests (MRs) instead of directly pushing to master.
+* Don't accept your own MRs, unless they are actually minor, like changing a `README` file. Otherwise ask someone else to test it.
+
+
+## Don't do this
+
+* Force pushing to remote branches, especially master. It's usually uncessary, just fix your own feature branch.
+* Rebasing or resetting remote branches. Doing it locally is fine. If you want to undo an already pushed commit, push a revert commit.
+* Squashing commits. I'm personally fine with it, but I think someone was against it? Not sure if it was a tutor, or not.