When adding the new annotations, there are a number of adjustments we may want to make at once.
We may need to relax linting rules first. When we do this, we may want to move faster on this part.
Use of None or 'n/a' should be avoided. For optional annotations, they should just be removed instead.
If marking a toggle as "temporary", we should note ensure there is a toggle_target_removal_date. If there is none, we could just add 3 months from the time of this PR, and note in the commit that we have filled these all in.
If marking a toggle as "permanent", but we are unsure, see ADR for language for toggle_permanent_justification. Could be something like: Tentatively marking as permanent. A DEPR could be used to confirm.
This ticket is for implementing ADR 0005-toggle-life-expectancy.rst. Please review for details.
Implementation/rollout details:
toggle_life_expectancy
annotation with values of "temporary" or "permanent" as optional.toggle_permanent_justification
as a free-form annotation as optional.toggle_use_cases
annotation should be made optional (until removed).toggle_permanent_justification
required for "permanent" toggles.toggle_target_removal_date
required for the new definition of "temporary" toggles, and no longer for the old definition.Additional Notes:
None
or 'n/a' should be avoided. For optional annotations, they should just be removed instead.toggle_target_removal_date
. If there is none, we could just add 3 months from the time of this PR, and note in the commit that we have filled these all in.toggle_permanent_justification
. Could be something like:Tentatively marking as permanent. A DEPR could be used to confirm.
temporary
use case might be missed when multiple use cases are listed.