Skip to content

Commit 83b9cd1

Browse files
authored
chore: guidelines for Pull Requests and general Merge Requirements (open-telemetry#1085)
1 parent 63dfcb5 commit 83b9cd1

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,31 @@ The `opentelemetry-js` project is written in TypeScript.
6363
- `npm test` tests code the same way that our CI will test it.
6464
- `npm run lint:fix` lint (and maybe fix) any changes.
6565

66+
### Guidelines for Pull Requests
67+
68+
- Typically we try to turn around reviews within one to two business days.
69+
- It is generally expected that a maintainer ([@open-telemetry/javascript-maintainers](https://github.com/orgs/open-telemetry/teams/javascript-maintainers)) should review and merge every PR.
70+
- If a change has met the requirements listed below, an approver may also merge the pull request.
71+
- Most PRs should be merged in one to two weeks.
72+
- If a PR is taking longer than 30 days, please ping the approvers ([@open-telemetry/javascript-approvers](https://github.com/orgs/open-telemetry/teams/javascript-approvers)) as it may have been lost
73+
- Dependency upgrades and Security fixes: This PR is small and/or low-risk and can be merged with only maintainer reviews.
74+
- If your patch is not getting reviewed or you need a specific person to review it, you can @username or @open-telemetry/javascript-approvers a reviewer asking for a review in the pull request, or you can ask for a review on Gitter channel.
75+
- API changes, breaking changes, or large changes will be subject to more scrutiny and may require more reviewers. These PRs should only be merged by maintainers.
76+
- Changes to existing plugins and exporters will typically require the approval of the original plugin/exporter author.
77+
78+
### General Merge Requirements
79+
80+
- All requirements are at the discretion of the maintainers.
81+
- Maintainers may merge pull requests which have not strictly met these requirements.
82+
- Maintainers may close, block, or put on hold pull requests even if they have strictly met these requirements.
83+
- No “changes requested” reviews.
84+
- No unresolved conversations.
85+
- 4 approvals, including the approvals of both maintainers
86+
- A pull request opened by an approver may be merged with only 3 reviews.
87+
- Small (simple typo, URL, update docs, or grammatical fix) or high-priority changes may be merged more quickly or with fewer reviewers at the discretion of the maintainers. This is typically indicated with the express label.
88+
- For plugins, exporters, and propagators approval of the original code module author is preferred but not required.
89+
- New or changed functionality is tested by unit tests.
90+
- New or changed functionality is documented.
6691

6792
### Generating API documentation
6893
- `npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-api/docs/out`

0 commit comments

Comments
 (0)