Skip to content

Commit 55aa688

Browse files
docs: Update review guidelines (#1052)
Add some detail to the "Review and feedback" section including expectations from reviewers and for reviewers before a PR can be merged.
1 parent c662f1c commit 55aa688

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,21 @@ merge. You'll probably get some feedback from these fine folks which helps to
208208
make the project that much better. Respond to the feedback and work with your
209209
reviewer(s) to resolve any issues.
210210

211+
The some of the things the code owners are looking for include:
212+
* a signed [CNCF CLA][cncf-cla]
213+
* a passing CI build
214+
* adherence to the principles and features outlined in the
215+
[instrumentation author's guide](.instrumentation/CONTRIBUTING.md)
216+
211217
Reviewers are responsible for ensuring that each merged PR's commit message
212218
conforms to [conventional commits](https://conventionalcommits.org). This may
213-
mean editing the commit message when you merge the pull request. Alternately,
214-
the reviewer may ask the pull request submitter to amend the commit message of
215-
their initial commit.
219+
mean editing the commit message or the pull request title when you merge the
220+
pull request. Alternately, the reviewer may ask the pull request submitter
221+
to amend the commit message of their initial commit.
222+
223+
In addition, when a change is complex or a reviewer is unfamiliar with the code,
224+
the reviewer may seek additional reviews from people more familiar with the
225+
change before merging a PR.
216226

217227
## Releases
218228

0 commit comments

Comments
 (0)