Skip to content

Commit 98bc818

Browse files
authored
Clarify how to make progress on a PR (open-telemetry#745)
1 parent 3fce938 commit 98bc818

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

CODEOWNERS .github/CODEOWNERS

File renamed without changes.

CONTRIBUTING.md

+73
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,76 @@ To quickly fix typos, use
8282
```bash
8383
make misspell-correction
8484
```
85+
86+
## Pull Requests
87+
88+
### How to create a PR
89+
90+
Everyone is welcome to contribute to the OpenTelemetry specification via GitHub
91+
pull requests (PRs).
92+
93+
To [create a new
94+
PR](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request),
95+
fork the project in GitHub and clone the upstream repo:
96+
97+
```sh
98+
git clone https://github.com/open-telemetry/opentelemetry-specification.git
99+
```
100+
101+
Add your fork as a remote:
102+
103+
```sh
104+
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-specification.git
105+
```
106+
107+
Check out a new branch, make modifications and push the branch to your fork:
108+
109+
```sh
110+
$ git checkout -b feature
111+
# edit files
112+
$ git commit
113+
$ git push fork feature
114+
```
115+
116+
Open a pull request against the main `opentelemetry-specification` repo.
117+
118+
If the PR is not ready for review, please mark it as
119+
[`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
120+
121+
Please make sure CLA is signed and CI is clear. We don't expect people to review
122+
and comment on a PR that doesn't have CLA signed.
123+
124+
### How to get your PR merged
125+
126+
A PR is considered to be **ready to merge** when:
127+
128+
* It has received more than two approvals from the [code
129+
owners](./.github/CODEOWNERS) (if approvals are from only one company, they
130+
won't count).
131+
* There is no `request changes` from the [code owners](./.github/CODEOWNERS).
132+
* It has been at least two working days since the last modification (except for
133+
the trivial updates, such like typo, cosmetic, rebase, etc.). This gives
134+
people reasonable time to review.
135+
* Trivial changes (typos, cosmetic changes, CI improvements, etc.) don't have to
136+
wait for two days.
137+
138+
Any [spec
139+
maintainer](https://github.com/open-telemetry/community/blob/master/community-members.md#specifications-and-proto) can
140+
merge the PR once it is **ready to merge**.
141+
142+
If a PR has been stuck (e.g. there are lots of debates and people couldn't agree
143+
on each other), the owner should try to get people aligned by:
144+
145+
* Consolidating the perspectives and putting a summary in the PR. It is
146+
recommended to add a link into the PR description, which points to a comment
147+
with a summary in the PR conversation.
148+
* Tagging subdomain experts (by looking at the change history) in the PR asking
149+
for suggestion.
150+
* Reaching out to more people on the [gitter
151+
channel](https://gitter.im/open-telemetry/opentelemetry-specification).
152+
* Stepping back to see if it makes sense to narrow down the scope of the PR or
153+
split it up.
154+
155+
If none of the above worked and the PR has been stuck for more than 2 weeks, the
156+
owner should bring it to the [OpenTelemetry Specification SIG
157+
meeting](https://github.com/open-telemetry/community#cross-language-specification).

docfx.json

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"resource": [
1212
{
1313
"files": [
14+
".github/CODEOWNERS",
1415
".markdownlint.yaml",
1516
".vscode/settings.json",
1617
"**.png"

0 commit comments

Comments
 (0)