From d12e75997cfb814e8e4fa6a07d31f797643d53eb Mon Sep 17 00:00:00 2001 From: Emil Lundmark Date: Tue, 26 Sep 2023 10:03:13 +0200 Subject: [PATCH] Add instructions for adding and removing field trials Since the registry now also stores the end date, the bug doesn't have to specify this. Bug: webrtc:14154 Change-Id: I94dee43105079607ff9d820e238018304eb441a2 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/321582 Reviewed-by: Mirko Bonadei Reviewed-by: Harald Alvestrand Commit-Queue: Emil Lundmark Cr-Commit-Position: refs/heads/main@{#40821} --- g3doc/field-trials.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/g3doc/field-trials.md b/g3doc/field-trials.md index e4f946a175..07234c81f0 100644 --- a/g3doc/field-trials.md +++ b/g3doc/field-trials.md @@ -40,6 +40,31 @@ The policy for field trials is: necessary, but should not be pushed back indefinitely. - A field trial must be associated with a bug that - reserves the field trial key, - - is open, - - is assigned to an owner, and - - has the end date specified. + - is open, and + - is assigned to an owner. + +## Creating a field trial + +Before creating a new field trial, make sure to read the [policy](#policy). + +Either create a new or reuse an existing bug and make it is open and assigned to +the correct owner. Take note of the bug ID. Next, decide how long you need the +field trial to last. It should be rare to have field trials lasting more than 12 +months. + +Using this information, add a new entry to `ACTIVE_FIELD_TRIALS` in +`experiments/field_trials.py`. You may not add new items to +`POLICY_EXEMPT_FIELD_TRIALS` since it is reserved for field trials that were +created before the policy was in place. + +## Removing a field trial + +Any field trial that has expired or otherwise is not needed anymore may be +removed by following these steps: + +- Remove all references from the code base. You can find these by, e.g. + grepping for the field trial key. +- Clean up potential glue code that might have been added. +- Remove the field trial from `ACTIVE_FIELD_TRIALS` in + `experiments/field_trials.py`. +- If all work is finished, also close the associated bug.