Skip to content

Add contributing / release guidance for breaking changes #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jack-berg merged 3 commits into from
Nov 13, 2025
Merged

Add contributing / release guidance for breaking changes #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d5a65e
Add contributing / release guidance for breaking changes
jack-berg Nov 4, 2025
33bb6a8
Merge branch 'main' into breaking-changes
codeboten Nov 4, 2025
75c618d
Merge branch 'main' into breaking-changes
codeboten Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,14 +434,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}))

@jack-berg jack-berg Nov 4, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleting this because we haven't been following this. Instead, we've been summarizing the changes as part of the release process.


```
* [`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
1 change: 1 addition & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<major>.<minor>.<patch>`. Increment `minor` by 1
Expand Down
Loading