Skip to content

Commit 579b647

Browse files
svrnmtheletterfopentelemetrybotcartermp
authored
Add approvers & maintainers corner to CONTRIBUTING.md (open-telemetry#3632)
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: opentelemetrybot <[email protected]> Co-authored-by: Phillip Carter <[email protected]>
1 parent 276fb12 commit 579b647

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,39 @@ the production server.
266266
To see deploy logs and more, visit project's [dashboard][] -- Netlify login
267267
required.
268268
269+
## Approver and Maintainer practices
270+
271+
This last section includes guidelines and some common practices used by
272+
approvers and maintainers while doing code reviews:
273+
274+
- PRs with changes to documentation co-owned by a SIG (collector, demo,
275+
language-specific...) should aim for two approvals: one by a docs approver and
276+
one by a SIG approver:
277+
- Doc approver label such PRs with `sig:<name>` and tag the SIG `-approvers`
278+
group on that PR
279+
- If no SIG approval is given within a certain grace period (two weeks in
280+
general, but may be less in urgent cases), docs maintainer may use their own
281+
judgement to merge that PR
282+
- If the PR branch is `out-of-date with the base branch`, they do not need to be
283+
updated continuously: every update triggers all the PR CI checks to be run!
284+
It's often enough to update them before merging.
285+
- A PR by non-maintainers should **never** update git sub modules. This happens
286+
by accident from time to time. Let the PR author know that they should not
287+
worry about it, we will fix this before merging, but in the future they should
288+
make sure that they work from an up-to-date fork.
289+
- If the contributor is having trouble signing the CLA or used the wrong email
290+
by mistake in one of their commits, ask them to fix the issue or rebase the
291+
pull request. Worst case scenario, close and re-open the PR to trigger a new
292+
CLA check.
293+
- Words unknown to cspell should be added to the cspell ignore list per page by
294+
PR authors. Only approvers and maintainers will add commonly used terms to the
295+
global list.
296+
- When an approver or maintainer won't be available to contribute for an
297+
extended period of time (more than a few days or a week) or won't be available
298+
in that period of time, they should communicate this using the
299+
[#otel-comms](https://cloud-native.slack.com/archives/C02UN96HZH6) channel and
300+
updating the GitHub status.
301+
269302
[.nvmrc]: .nvmrc
270303
[clone]:
271304
https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository

0 commit comments

Comments
 (0)