diff --git a/doc/contributing/danger.md b/doc/contributing/danger.md new file mode 100644 index 0000000000000000000000000000000000000000..7a351dcc3b2aa0b5aca090fb39850cb1e19ec793 --- /dev/null +++ b/doc/contributing/danger.md @@ -0,0 +1,26 @@ +# 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. + +## Reviewer roulette + +The reviewer roulette randomly picks reviewers based on the type of changes and on the +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. + +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 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](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.