From 3852524dc4c50a41f63a133935d727cd198b81bd Mon Sep 17 00:00:00 2001 From: Lukas Eipert Date: Fri, 16 Mar 2018 11:11:09 +0100 Subject: add outline of merge request review documentation --- doc/development/new_fe_guide/development/index.md | 4 ++++ .../development/merge_request_review.md | 21 +++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 doc/development/new_fe_guide/development/merge_request_review.md 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 + + +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) + -- cgit v1.2.1