Skip to content

Commit d3d5e06

Browse files
authored
[chore] Clarify config removal in CONTRIBUTING.md (#10582)
#### Description Clarify that deprecated config options are expected to remain for at least 6 months after deprecation. "MUST NOT" makes it clear for readers that this is something that definitely should not be done, vs. something that's discretionary. See also open-telemetry/opentelemetry-collector-contrib#33776 (comment)
1 parent cb24d0c commit d3d5e06

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ When renaming or removing a configuration option:
642642
- a WARN level message should be logged, with a link to a place within the component's repository where the change is
643643
documented and a migration path is provided
644644
- the option MUST be kept for at least N+1 version and MAY be hidden behind a feature gate in N+2
645-
- the option and the WARN level message MAY be removed after N+2 or 6 months, whichever comes later
645+
- the option and the WARN level message MUST NOT be removed earlier than N+2 or 6 months, whichever comes later
646646

647647
Additionally, when removing an option:
648648
- the option MAY be made non-operational already by the same version where it is deprecated

0 commit comments

Comments
 (0)