Skip to content

Commit

Permalink
[chore] Clarify config removal in CONTRIBUTING.md (#10582)
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
axw authored Aug 16, 2024
1 parent cb24d0c commit d3d5e06
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ When renaming or removing a configuration option:
- a WARN level message should be logged, with a link to a place within the component's repository where the change is
documented and a migration path is provided
- the option MUST be kept for at least N+1 version and MAY be hidden behind a feature gate in N+2
- the option and the WARN level message MAY be removed after N+2 or 6 months, whichever comes later
- the option and the WARN level message MUST NOT be removed earlier than N+2 or 6 months, whichever comes later

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

0 comments on commit d3d5e06

Please sign in to comment.