Skip to content

Commit 508a3ed

Browse files
svrnmopentelemetrybottheletterf
authored
Update approver and maintainer practices (#4684)
Co-authored-by: opentelemetrybot <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent 499eab8 commit 508a3ed

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

content/en/docs/contributing/development.md

+39
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Development
33
description:
44
Learn how to set up a development environment for the opentelemetry.io site.
55
weight: 60
6+
cSpell:ignore: chalin
67
---
78

89
The following instructions explain how to set up a development environment for
@@ -131,9 +132,27 @@ approvers and maintainers while doing code reviews:
131132
one by a SIG approver:
132133
- Doc approver label such PRs with `sig:<name>` and tag the SIG `-approvers`
133134
group on that PR
135+
- After a doc approver has reviewed and approved the PR, they can add the
136+
label
137+
[`sig-approval-missing`](https://github.com/open-telemetry/opentelemetry.io/labels/sig-approval-missing).
138+
This signals to the SIG that they need to handle the PR
134139
- If no SIG approval is given within a certain grace period (two weeks in
135140
general, but may be less in urgent cases), docs maintainer may use their own
136141
judgement to merge that PR
142+
- PRs created by bots can be merged by the following practice:
143+
- PRs that auto-update versions in the registry can be fixed, approved and
144+
merged immediately
145+
- PRs that auto-update the versions of SDKs, zero-code instrumentations or the
146+
collector can be approved and merged except the corresponding SIG signals
147+
that merging should be postponed
148+
- PRs that auto-update the version of any specification often require updates
149+
to scripts for the CI checks to pass. In that case often
150+
[@chalin](https://github.com/chalin/) will handle that PR. Otherwise those
151+
PRs can as well be approved and merged except the corresponding SIG signals
152+
that merging should be postponed.
153+
- PRs with changes to translations should aim for two approvals: one by a docs
154+
approver and one by a translation approver. Similar practices apply as
155+
suggested for the co-owned PRs.
137156
- If the PR branch is `out-of-date with the base branch`, they do not need to be
138157
updated continuously: every update triggers all the PR CI checks to be run!
139158
It's often enough to update them before merging.
@@ -148,11 +167,31 @@ approvers and maintainers while doing code reviews:
148167
- Words unknown to cspell should be added to the cspell ignore list per page by
149168
PR authors. Only approvers and maintainers will add commonly used terms to the
150169
global list.
170+
- Approvers and maintainers have different work schedules and circumstances.
171+
That's why all communication is assumed to be asynchronously and they should
172+
not feel obligated to reply outside of their normal schedule.
151173
- When an approver or maintainer won't be available to contribute for an
152174
extended period of time (more than a few days or a week) or won't be available
153175
in that period of time, they should communicate this using the
154176
[#otel-comms](https://cloud-native.slack.com/archives/C02UN96HZH6) channel and
155177
updating the GitHub status.
178+
- Approver and maintainer adhere to the
179+
[OTel Code of Conduct](https://github.com/open-telemetry/community/?tab=coc-ov-file#opentelemetry-community-code-of-conduct)
180+
and are friendly and helpful towards contributors. In the case of a conflict,
181+
misunderstanding or any other kind of situation that makes an
182+
approver/maintainer feel uncomfortable they can step back from a conversation,
183+
issue or PR and ask another approver/maintainer to step in.
184+
185+
The following workflow can be applied by maintainers to merge PRs:
186+
187+
- Make sure that a PR has all approvals and all CI checks pass
188+
- If the branch is out-of-date, rebase update it via the GitHub UI.
189+
- The update will trigger all CI checks to run again, wait for them to pass or
190+
execute a script like the following to make it happen in the background:
191+
192+
```shell
193+
export PR=<ID OF THE PR>; gh pr checks ${PR} --watch && gh pr merge ${PR} --squash
194+
```
156195
157196
[clone]:
158197
https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository

static/refcache.json

+8
Original file line numberDiff line numberDiff line change
@@ -2503,6 +2503,10 @@
25032503
"StatusCode": 200,
25042504
"LastSeen": "2024-01-30T15:25:16.58574-05:00"
25052505
},
2506+
"https://github.com/chalin/": {
2507+
"StatusCode": 200,
2508+
"LastSeen": "2024-06-14T09:35:29.965101669Z"
2509+
},
25062510
"https://github.com/cloudflare/cfssl": {
25072511
"StatusCode": 200,
25082512
"LastSeen": "2024-01-18T19:36:55.954418-05:00"
@@ -4311,6 +4315,10 @@
43114315
"StatusCode": 200,
43124316
"LastSeen": "2024-01-18T19:09:43.270324-05:00"
43134317
},
4318+
"https://github.com/open-telemetry/opentelemetry.io/labels/sig-approval-missing": {
4319+
"StatusCode": 200,
4320+
"LastSeen": "2024-06-14T09:35:27.61260596Z"
4321+
},
43144322
"https://github.com/open-telemetry/opentelemetry.io/pull/2130": {
43154323
"StatusCode": 200,
43164324
"LastSeen": "2024-01-30T15:26:13.725828-05:00"

0 commit comments

Comments
 (0)