summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukas Eipert <git@leipert.io>2018-03-16 11:11:09 +0100
committerLukas Eipert <git@leipert.io>2018-03-16 11:11:09 +0100
commit3852524dc4c50a41f63a133935d727cd198b81bd (patch)
tree7773eb7e2866a389483d2a51284781fba0cc86b1
parent3c1dd2343f6823b564f7e88b47953e596af884af (diff)
downloadgitlab-ce-le-frontend-mr-review-template.tar.gz
add outline of merge request review documentationle-frontend-mr-review-template
-rw-r--r--doc/development/new_fe_guide/development/index.md4
-rw-r--r--doc/development/new_fe_guide/development/merge_request_review.md21
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/development/new_fe_guide/development/index.md b/doc/development/new_fe_guide/development/index.md
index cee8e43ebad..5fcf21f750a 100644
--- a/doc/development/new_fe_guide/development/index.md
+++ b/doc/development/new_fe_guide/development/index.md
@@ -27,3 +27,7 @@ Learn how to keep our frontend performant.
## [Testing](testing.md)
Learn how to keep our frontend tested.
+
+## [Merge Request Review](merge_request_review.md)
+
+Learn how our frontend maintainers review merge requests.
diff --git a/doc/development/new_fe_guide/development/merge_request_review.md b/doc/development/new_fe_guide/development/merge_request_review.md
new file mode 100644
index 00000000000..b3aa2ef75f6
--- /dev/null
+++ b/doc/development/new_fe_guide/development/merge_request_review.md
@@ -0,0 +1,21 @@
+
+# Merge request reviews
+
+<!-- Maybe add a list of maintainers from the team page, so that people might now who to ping? -->
+Once your contribution is ready for review by one of our frontend maintainers, they will post a comment with a checklist into your Merge Request.
+This helps the contributor to understand which points are important for the frontend maintainers.
+Furthermore the maintainers have it easier to hold everyone responsible to a collective standard rather than individual ones.
+You can find the current checklist below:
+
+- - -
+
+*General*
+
+- [ ] The code is styled correctly [(?)](https://docs.gitlab.com/ce/development/new_fe_guide/style/index.html)
+- [ ] jQuery is only used if necessary [(?)](https://docs.gitlab.com/ce/development/new_fe_guide/principles.html)
+
+*Vue*
+
+- [ ] Adherence of naming conventions [(?)](http://example.org)
+- [ ] VueX Stores are unit tested [(?)](http://example.org)
+