Skip to content

Commit

Permalink
docs: Update review guidelines (#1052)
Browse files Browse the repository at this point in the history
Add some detail to the "Review and feedback" section including
expectations from reviewers and for reviewers before a PR can be merged.
  • Loading branch information
kaylareopelle authored Jul 15, 2024
1 parent c662f1c commit 55aa688
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,11 +208,21 @@ merge. You'll probably get some feedback from these fine folks which helps to
make the project that much better. Respond to the feedback and work with your
reviewer(s) to resolve any issues.

The some of the things the code owners are looking for include:
* a signed [CNCF CLA][cncf-cla]
* a passing CI build
* adherence to the principles and features outlined in the
[instrumentation author's guide](.instrumentation/CONTRIBUTING.md)

Reviewers are responsible for ensuring that each merged PR's commit message
conforms to [conventional commits](https://conventionalcommits.org). This may
mean editing the commit message when you merge the pull request. Alternately,
the reviewer may ask the pull request submitter to amend the commit message of
their initial commit.
mean editing the commit message or the pull request title when you merge the
pull request. Alternately, the reviewer may ask the pull request submitter
to amend the commit message of their initial commit.

In addition, when a change is complex or a reviewer is unfamiliar with the code,
the reviewer may seek additional reviews from people more familiar with the
change before merging a PR.

## Releases

Expand Down

0 comments on commit 55aa688

Please sign in to comment.