From 7d5a65eed662ccfab08bb12332385d8aa79629ec Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Tue, 4 Nov 2025 15:33:52 -0600 Subject: [PATCH] Add contributing / release guidance for breaking changes --- CONTRIBUTING.md | 9 +++------ RELEASING.md | 1 + 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7057357..cb01f5c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -414,14 +414,11 @@ A PR is ready to merge when: * There is no `request changes` from the [codeowners](.github/CODEOWNERS) * If a change to the schema, at least one [example](examples/) is updated to illustrate change * All required status checks pass -* The PR includes a [CHANGELOG](CHANGELOG.md) entry under `## UNRELEASED` following the form: +* Has been tagged with any applicable [labels](#labels) -```markdown +### Labels -* {Brief description of change} - ([#{PR Number}]({https://github.com/open-telemetry/opentelemetry-configuration/pull/{PR Number})) - -``` +* [`breaking`](https://github.com/open-telemetry/opentelemetry-configuration/pulls?q=is%3Apr+label%3Abreaking+): applied to PRs which qualify as breaking changes according to the [stability definition](README.md#stability-definition), including breaking changes to [experimental features](README.md#experimental-features) which are allowed in minor versions. [env var substitution]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/data-model.md#environment-variable-substitution [nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating diff --git a/RELEASING.md b/RELEASING.md index dae20d77..deaf56a6 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -19,6 +19,7 @@ should be "main". * Click "Generate release notes" to get a draft release notes. Refer to [CHANGELOG.md](CHANGELOG.md) for a list of changes since last release. + * Call out [breaking changes](CONTRIBUTING.md#pull-requests) and provide example migration steps (see [v0.4.0](https://github.com/open-telemetry/opentelemetry-configuration/releases/tag/v0.4.0) for an example). * Click "Publish Release". Our tags follow the naming convention of `v..`. Increment `minor` by 1