Skip to content

Commit 9c5ac34

Browse files
committed
PR feedback updates
1 parent eee165a commit 9c5ac34

File tree

2 files changed

+28
-59
lines changed

2 files changed

+28
-59
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,34 @@ Before submitting new features or changes to current functionality, it is recomm
66
[open an issue](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/new)
77
and discuss your ideas or propose the changes you wish to make.
88

9-
**Breaking Changes**: If your PR introduces a breaking change, please add the `breaking change` label.
10-
This will trigger automation to help you document the change properly.
11-
See [Breaking Changes Automation](RELEASING.md#breaking-changes-and-deprecations-automation) for more details.
9+
10+
## Breaking Changes
11+
12+
When your PR introduces a breaking change:
13+
14+
* Add the `breaking change` label to your PR
15+
* Provide migration notes in the PR description:
16+
- What is changing and why
17+
- How users should update their code/configuration
18+
- Code examples showing before/after usage (if applicable)
19+
20+
**When to Use:**
21+
22+
* API changes that break backward compatibility
23+
* Configuration changes that require user action
24+
* Behavioral changes that might affect existing users
25+
* Removal of deprecated features
26+
27+
## Deprecations
28+
29+
When your PR deprecates functionality:
30+
31+
* Add the `deprecation` label to your PR
32+
* Provide deprecation details in the PR description:
33+
- What is being deprecated and why
34+
- What should be used instead (if applicable)
35+
- Timeline for removal (if known)
36+
- Any migration guidance
1237

1338
## Building
1439

RELEASING.md

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -74,62 +74,6 @@ and deadlocks.
7474
(note that if this is not a patch release then the change log on main may already be up-to-date,
7575
in which case no pull request will be created).
7676

77-
## Breaking Changes and Deprecations Automation
78-
79-
This project includes automation to help track and communicate breaking changes and deprecations to users.
80-
81-
### For Contributors
82-
83-
#### Breaking Changes
84-
When your PR introduces a breaking change:
85-
86-
1. **Apply the Label**: Add the `breaking change` label to your PR
87-
2. **Respond to Automation**: A bot will comment with guidance on documenting the breaking change
88-
3. **Provide Migration Notes**: Add detailed migration notes to your PR description or as a comment, including:
89-
- What is changing and why
90-
- How users should update their code/configuration
91-
- Code examples showing before/after usage (if applicable)
92-
93-
#### Deprecations
94-
When your PR deprecates functionality:
95-
96-
1. **Apply the Label**: Add the `deprecation` label to your PR
97-
2. **Respond to Automation**: A bot will comment with guidance on documenting the deprecation
98-
3. **Provide Deprecation Details**: Add details to your PR description or as a comment, including:
99-
- What is being deprecated and why
100-
- What should be used instead (if applicable)
101-
- Timeline for removal (if known)
102-
- Any migration guidance
103-
104-
### For Maintainers
105-
106-
During PR review, ensure:
107-
- Migration notes are clear
108-
- The breaking change is properly categorized
109-
- The impact is well understood
110-
111-
### Automation Details
112-
113-
The breaking changes automation includes:
114-
115-
- **PR Comment Bot** (`.github/workflows/breaking-change-pr-comment.yml`): Automatically comments on PRs with the `breaking change` label, providing guidance and a checklist for the author
116-
- **Changelog Integration** (`.github/scripts/extract-breaking-changes.sh`): Extracts PRs with breaking change labels and includes them in the changelog template
117-
- **Release Notes Enhancement** (`.github/workflows/release.yml`): Highlights breaking changes prominently in GitHub release notes
118-
119-
Breaking changes are automatically:
120-
- Included in the "Breaking Changes" section of the changelog template generated by `draft-change-log-entries.sh`
121-
- Highlighted at the top of GitHub release notes with links to the original PRs
122-
- Linked to migration notes provided by contributors
123-
124-
### Label Requirements
125-
126-
- **Label Name**: `breaking change` (exact match, case sensitive)
127-
- **When to Use**:
128-
- API changes that break backward compatibility
129-
- Configuration changes that require user action
130-
- Behavioral changes that might affect existing users
131-
- Removal of deprecated features
132-
13377
## Credentials
13478

13579
Same as the core repo, see [opentelemetry-java/RELEASING.md#credentials](https://github.com/open-telemetry/opentelemetry-java/blob/main/RELEASING.md#credentials).

0 commit comments

Comments
 (0)