Skip to content

Commit 553948e

Browse files
lmolkovaarminru
andauthored
Add reviewer guidelines (#2966)
Co-authored-by: Armin Ruech <[email protected]>
1 parent c32b520 commit 553948e

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ requirements and recommendations.
2727
- [Examples](#examples)
2828
- [Adding a changelog entry](#adding-a-changelog-entry)
2929
- [5. Getting your PR merged](#5-getting-your-pr-merged)
30+
- [Reviewer guidelines](#reviewer-guidelines)
3031
- [Automation](#automation)
3132
- [Consistency checks](#consistency-checks)
3233
- [Auto formatting](#auto-formatting)
@@ -287,10 +288,9 @@ Alternately, copy `./.chloggen/TEMPLATE.yaml`, or just create your file from scr
287288

288289
A PR (pull request) is considered to be **ready to merge** when:
289290

290-
- It has received at least two approvals from the [code
291-
owners](./.github/CODEOWNERS) (if approvals are from only one company, they
292-
won't count)
293-
- There is no `request changes` from the [code owners](./.github/CODEOWNERS)
291+
- It has received at least two approvals from the [code owners](./.github/CODEOWNERS)
292+
- There is no `request changes` from the [code owners](./.github/CODEOWNERS) for
293+
affected area(s)
294294
- There is no open discussions
295295
- It has been at least two working days since the last modification (except for
296296
the trivial updates, such like typo, cosmetic, rebase, etc.). This gives
@@ -301,6 +301,35 @@ A PR (pull request) is considered to be **ready to merge** when:
301301
Any [maintainer](./README.md#contributing) can merge the PR once it is **ready
302302
to merge**.
303303

304+
## Reviewer guidelines
305+
306+
Semantic conventions consist of multiple [areas](./AREAS.md) with ownership
307+
defined in the [CODEOWNERS](./.github/CODEOWNERS) file.
308+
309+
When a PR is raised against specific area(s), it is recommended to allow the corresponding
310+
area(s) owners to review and iterate on it first before approving or rejecting the PR.
311+
312+
A review from [@specs-semconv-approvers](https://github.com/orgs/open-telemetry/teams/specs-semconv-approvers)
313+
is required on every PR and, in most cases, follows after area(s) owners approval.
314+
315+
Before merging a PR, [@specs-semconv-maintainers](https://github.com/orgs/open-telemetry/teams/specs-semconv-maintainers)
316+
MUST verify that the PR has been approved by the corresponding area owner(s). For
317+
non-trivial changes, maintainers SHOULD NOT merge PRs without other code owner approvals.
318+
319+
Reviews from non-code owners are encouraged, with the following assumptions:
320+
321+
- There is a reasonable intersection between the change and the reviewer's area of expertise or interest
322+
- Area owners have autonomy to accept or dismiss feedback from non-codeowners and
323+
SHOULD consult with [@specs-semconv-maintainers](https://github.com/orgs/open-telemetry/teams/specs-semconv-maintainers)
324+
in case of conflicts
325+
326+
When reviewing changes, reviewers SHOULD include relevant context such as:
327+
328+
- Links to documentation related to the technology in question
329+
- Links to applicable semantic conventions or OpenTelemetry guidelines
330+
- Links to relevant PRs, issues, or discussions
331+
- Reasons for suggesting the change
332+
304333
## Automation
305334

306335
Semantic Conventions provides a set of automated tools for general development.

0 commit comments

Comments
 (0)