From 1ecc034836a1df9237bf1d57e8aa5aa1ccf0f983 Mon Sep 17 00:00:00 2001 From: Paul Gascou-Vaillancourt Date: Tue, 15 Jun 2021 09:54:26 -0400 Subject: [PATCH 1/6] docs: document Danger setup --- doc/contributing/danger.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/contributing/danger.md diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md new file mode 100644 index 0000000000..485d1a5023 --- /dev/null +++ b/doc/contributing/danger.md @@ -0,0 +1,27 @@ +# How is Danger used in GitLab UI? + +We have setup [Danger](https://danger.systems/) in GitLab UI to streamline the review workflow and +catch some mistakes that reviewers might miss or not be aware of. + +## Roulette + +The reviewers roulette will randomly pick reviewers based on the type of changes and on the +reviewers availability. You _can_ but don't _have to_ follow Danger's recommendations when putting +an MR out for review. Use your best judgement as to who is best fit to review your changes, or +whether some reviews can be skipped altogether. + +Danger will also pick a Product Designer to review MRs that have a `~"component:*"` label. Whenever +possible, Danger will pick the expert Product Designer for a given component. Otherwise, any UX +Foundations designer can be assigned. + +## Semantic commits + +Danger checks commits formatting to ensure that they follow our commit conventions, and to give some +hints on what kind of version will be released when they are merged. Read more about our [commit +conventions](./commits.md). + +## Examples + +We are currently migrating GitLab UI' stories to a new format. As part of this migration, we are +deprecating component examples. Danger will show a warning whenever an example is added or changed. +[Read more about examples' removal](../../FAQ.md#i-used-to-write-examples-in-addition-to-stories-is-that-still-a-thing). -- GitLab From 469e3e4cbe7bd6f8ec3d3891bcef3274128df053 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Mon, 28 Jun 2021 20:06:01 +0000 Subject: [PATCH 2/6] Apply 7 suggestion(s) to 1 file(s) --- doc/contributing/danger.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md index 485d1a5023..8ca9034800 100644 --- a/doc/contributing/danger.md +++ b/doc/contributing/danger.md @@ -1,22 +1,22 @@ # How is Danger used in GitLab UI? -We have setup [Danger](https://danger.systems/) in GitLab UI to streamline the review workflow and -catch some mistakes that reviewers might miss or not be aware of. +We use [Danger](https://danger.systems/) in the GitLab UI codebase to streamline the review workflow and +catch mistakes that reviewers might miss or not be aware of. -## Roulette +## Reviwer roulette -The reviewers roulette will randomly pick reviewers based on the type of changes and on the +The reviewer roulette randomly picks reviewers based on the type of changes and on the reviewers availability. You _can_ but don't _have to_ follow Danger's recommendations when putting an MR out for review. Use your best judgement as to who is best fit to review your changes, or whether some reviews can be skipped altogether. -Danger will also pick a Product Designer to review MRs that have a `~"component:*"` label. Whenever -possible, Danger will pick the expert Product Designer for a given component. Otherwise, any UX +Danger also picks a Product Designer to review MRs that have a `~"component:*"` label. Whenever +possible, Danger picks the expert Product Designer for a given component. Otherwise, any UX Foundations designer can be assigned. ## Semantic commits -Danger checks commits formatting to ensure that they follow our commit conventions, and to give some +Danger checks commit formatting to ensure that they follow our commit conventions and to give some hints on what kind of version will be released when they are merged. Read more about our [commit conventions](./commits.md). -- GitLab From e2912e232a48b352cf40bb5b827875ac02d9639d Mon Sep 17 00:00:00 2001 From: Paul Gascou-Vaillancourt Date: Mon, 28 Jun 2021 16:09:35 -0400 Subject: [PATCH 3/6] Add link to epic and use present tense --- doc/contributing/danger.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md index 8ca9034800..c29a8f2258 100644 --- a/doc/contributing/danger.md +++ b/doc/contributing/danger.md @@ -22,6 +22,7 @@ conventions](./commits.md). ## Examples -We are currently migrating GitLab UI' stories to a new format. As part of this migration, we are -deprecating component examples. Danger will show a warning whenever an example is added or changed. +We are currently migrating GitLab UI' stories to a new format ([migration epic](https://gitlab.com/groups/gitlab-org/-/epics/5651)). +As part of this migration, we are deprecating component examples. Danger shows a warning whenever +an example is added or changed. [Read more about examples' removal](../../FAQ.md#i-used-to-write-examples-in-addition-to-stories-is-that-still-a-thing). -- GitLab From 8f0c2cd5fbd85e6dc0bc8e57a2d1b26112a9726d Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Tue, 29 Jun 2021 12:38:36 +0000 Subject: [PATCH 4/6] Apply 3 suggestion(s) to 1 file(s) --- doc/contributing/danger.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md index c29a8f2258..b21d7419a8 100644 --- a/doc/contributing/danger.md +++ b/doc/contributing/danger.md @@ -18,11 +18,11 @@ Foundations designer can be assigned. Danger checks commit formatting to ensure that they follow our commit conventions and to give some hints on what kind of version will be released when they are merged. Read more about our [commit -conventions](./commits.md). +Danger checks commit formatting to ensure that they follow our [commit conventions](./commits.md) +and to give some hints on what kind of version will be released when they are merged. ## Examples -We are currently migrating GitLab UI' stories to a new format ([migration epic](https://gitlab.com/groups/gitlab-org/-/epics/5651)). -As part of this migration, we are deprecating component examples. Danger shows a warning whenever -an example is added or changed. -[Read more about examples' removal](../../FAQ.md#i-used-to-write-examples-in-addition-to-stories-is-that-still-a-thing). +We are currently [migrating GitLab UI' stories to a new format](https://gitlab.com/groups/gitlab-org/-/epics/5651). +As part of this migration, we are [deprecating component examples](../../FAQ.md#i-used-to-write-examples-in-addition-to-stories-is-that-still-a-thing). +Danger shows a warning whenever an example is added or changed. -- GitLab From f87c847dc37eb1eca27d21f77f7658e443badef6 Mon Sep 17 00:00:00 2001 From: Paul Gascou-Vaillancourt Date: Tue, 29 Jun 2021 08:41:01 -0400 Subject: [PATCH 5/6] Remove duplicated sentence and wrap lines --- doc/contributing/danger.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md index b21d7419a8..9476f7af42 100644 --- a/doc/contributing/danger.md +++ b/doc/contributing/danger.md @@ -1,7 +1,7 @@ # How is Danger used in GitLab UI? -We use [Danger](https://danger.systems/) in the GitLab UI codebase to streamline the review workflow and -catch mistakes that reviewers might miss or not be aware of. +We use [Danger](https://danger.systems/) in the GitLab UI codebase to streamline the review workflow +and catch mistakes that reviewers might miss or not be aware of. ## Reviwer roulette @@ -16,8 +16,6 @@ Foundations designer can be assigned. ## Semantic commits -Danger checks commit formatting to ensure that they follow our commit conventions and to give some -hints on what kind of version will be released when they are merged. Read more about our [commit Danger checks commit formatting to ensure that they follow our [commit conventions](./commits.md) and to give some hints on what kind of version will be released when they are merged. -- GitLab From 3d738d64fdaa3e9172c7126441734594877fd509 Mon Sep 17 00:00:00 2001 From: Simon Knox Date: Wed, 30 Jun 2021 06:42:02 +0000 Subject: [PATCH 6/6] Apply 3 suggestion(s) to 1 file(s) --- doc/contributing/danger.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md index 9476f7af42..7a351dcc3b 100644 --- a/doc/contributing/danger.md +++ b/doc/contributing/danger.md @@ -3,10 +3,10 @@ We use [Danger](https://danger.systems/) in the GitLab UI codebase to streamline the review workflow and catch mistakes that reviewers might miss or not be aware of. -## Reviwer roulette +## Reviewer roulette The reviewer roulette randomly picks reviewers based on the type of changes and on the -reviewers availability. You _can_ but don't _have to_ follow Danger's recommendations when putting +reviewer's availability. You _can_ but don't _have to_ follow Danger's recommendations when putting an MR out for review. Use your best judgement as to who is best fit to review your changes, or whether some reviews can be skipped altogether. @@ -21,6 +21,6 @@ and to give some hints on what kind of version will be released when they are me ## Examples -We are currently [migrating GitLab UI' stories to a new format](https://gitlab.com/groups/gitlab-org/-/epics/5651). +We are currently [migrating GitLab UI stories to a new format](https://gitlab.com/groups/gitlab-org/-/epics/5651). As part of this migration, we are [deprecating component examples](../../FAQ.md#i-used-to-write-examples-in-addition-to-stories-is-that-still-a-thing). Danger shows a warning whenever an example is added or changed. -- GitLab