summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2017-03-15 15:49:16 +0100
committerRémy Coutable <remy@rymai.me>2017-03-16 12:42:18 +0100
commitcecf7328700626c703f5a5c3ed8f1e7dc831107d (patch)
tree2743bf13ce14665ca5f9ab976a135c4a8a5e1812
parent3735266d844465c33294983538928afbe3f2c080 (diff)
downloadgitlab-ce-improve-mr-reviews-in-contributing.tar.gz
Improve the MR guidelines from the CONTRIBUTING guideimprove-mr-reviews-in-contributing
[ci skip] Signed-off-by: Rémy Coutable <remy@rymai.me>
-rw-r--r--CONTRIBUTING.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ae143c58290..923cdd8150c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -307,9 +307,12 @@ request is as follows:
organized commits by [squashing them][git-squash]
1. Push the commit(s) to your fork
1. Submit a merge request (MR) to the `master` branch
-1. Leave the approvals settings as they are:
- 1. Your merge request needs at least 1 approval
- 1. You don't have to select any approvers
+ 1. Your merge request needs at least 1 approval but feel free to require more.
+ For instance if you're touching backend and frontend code, it's a good idea
+ to require 2 approvals: 1 from a backend maintainer and 1 from a frontend
+ maintainer
+ 1. You don't have to select any approvers, but you can if you really want
+ specific people to approve your merge request
1. The MR title should describe the change you want to make
1. The MR description should give a motive for your change and the method you
used to achieve it.
@@ -369,7 +372,7 @@ There are a few rules to get your merge request accepted:
1. If your merge request includes only frontend changes [^1], it must be
**approved by a [frontend maintainer][team]**.
1. If your merge request includes frontend and backend changes [^1], it must
- be approved by a frontend **and** a backend maintainer.
+ be **approved by a [frontend and a backend maintainer][team]**.
1. To lower the amount of merge requests maintainers need to review, you can
ask or assign any [reviewers][team] for a first review.
1. If you need some guidance (e.g. it's your first merge request), feel free
@@ -549,6 +552,5 @@ available at [http://contributor-covenant.org/version/1/1/0/](http://contributor
[GitLab Inc engineering workflow]: https://about.gitlab.com/handbook/engineering/workflow/#labelling-issues
[polling-etag]: https://docs.gitlab.com/ce/development/polling.html
-[^1]: Specs other than JavaScript specs are considered backend code. Haml
- changes are considered backend code if they include Ruby code other than just
- pure HTML.
+[^1]: Please note that specs other than JavaScript specs are considered backend
+ code.