From c2ca9d44d613226313a43e5ab7673308febe6d76 Mon Sep 17 00:00:00 2001 From: Michael Winsauer Date: Sat, 24 Nov 2018 07:56:26 +0100 Subject: [PATCH] First draft of contribution guide --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3a6547..ee52a52 100644 --- 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. -- 2.43.0