Commit 113f6b32 authored by Craig Norris's avatar Craig Norris

Merge branch 'patch-238' into 'master'

Edit `Code reviews` paragraphs for clarity.

See merge request gitlab-org/gitlab!42930
parents d85e7fc8 e910f67d
...@@ -16,11 +16,19 @@ In either case, an outcome of the experiment should be posted to the issue with ...@@ -16,11 +16,19 @@ In either case, an outcome of the experiment should be posted to the issue with
## Code reviews ## Code reviews
Since the code of experiments will not be part of the codebase for a long time and we want to iterate fast to retrieve data, the code quality of experiments might sometimes not fulfill our standards but should not negatively impact the availability of GitLab whether the experiment is running or not. Experiments' code quality can fail our standards for several reasons. These
Initially experiments will only be deployed to a fraction of users but we still want a flawless experience for those users. Therefore, experiments still require tests. reasons can include not being added to the codebase for a long time, or because
of fast iteration to retrieve data. However, having the experiment run (or not
For reviewers and maintainers: if you find code that would usually not make it through the review, but is temporarily acceptable, please mention your concerns but note that it's not necessary to change. run) shouldn't impact GitLab's availability. To avoid or identify issues,
The author then adds a comment to this piece of code and adds a link to the issue that resolves the experiment. If the experiment is successful and becomes part of the product these follow up issues should be addressed. experiments are initially deployed to a small number of users. Regardless,
experiments still need tests.
If, as a reviewer or maintainer, you find code that would usually fail review
but is acceptable for now, mention your concerns with a note that there's no
need to change the code. The author can then add a comment to this piece of code
and link to the issue that resolves the experiment. If the experiment is
successful and becomes part of the product, any follow up issues should be
addressed.
## How to create an A/B test ## How to create an A/B test
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment