Skip to content

Commit a18b074

Browse files
authored
docs: document merge reqiurements (#1553)
* docs: document merge reqiurements * docs: remove redundant wording * docs: remove redundant wording * docs: lint
1 parent 784a422 commit a18b074

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,6 @@ The `opentelemetry-js-contrib` project is written in TypeScript.
8787
- `npm test` tests code the same way that our CI will test it.
8888
- `npm run lint:fix` lint (and maybe fix) any changes.
8989

90-
### Generating API documentation
91-
92-
- `npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-api/docs/out`
93-
9490
### Generating CHANGELOG documentation
9591

9692
- `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).
@@ -117,6 +113,9 @@ A component may be **unreleased**, **experimental**, **beta**, **stable**, **unm
117113
With the exception of the stable status, it is up to each individual [component owner](#component-ownership) to determine the status of a component.
118114
A component may only be marked stable with the approval of a member of @open-telemetry/javascript-maintainers; see the definition of stable below for more details.
119115

116+
A Pull Request modifying components in any stage of the lifecycle is subject to the
117+
[Pull Request Merge Requirements](#pull-request-merge-requirements).
118+
120119
### Unreleased
121120

122121
Unreleased components are in active development and have not yet been released to NPM.
@@ -162,6 +161,33 @@ They may not work and there are no guarantees for fixes or new features.
162161
Their source files may be deleted from the repository.
163162
Any packages released from their source will be marked as deprecated in NPM.
164163

164+
## Pull Request Merge Requirements
165+
166+
Pull requests MAY be merged by an approver OR a maintainer provided they meet all the following requirements:
167+
168+
- Approved by
169+
- at least one component owner if one is defined in [.github/component_owners.yml](.github/component_owners.yml)
170+
- OR one maintainer
171+
- OR at least one approver who is not the approver merging the pull request
172+
- A pull request for small (simple typo, URL, update docs, or grammatical fix) changes may be approved and merged by the same approver
173+
- No “changes requested” reviews or unresolved conversations by
174+
- approvers
175+
- maintainers
176+
- technical committee members
177+
- component owners
178+
- subject-matter experts
179+
- New or changed functionality is tested by unit tests
180+
- New or changed functionality is documented if appropriate
181+
- Substantial changes should not be merged within 24 hours of opening in order to allow reviewers from all time zones to have a chance to review
182+
183+
All requirements are at the discretion of the maintainers.
184+
Maintainers MAY merge pull requests which have not strictly met these requirements.
185+
Maintainers MAY close, block, or put on hold pull requests even if they have strictly met these requirements.
186+
187+
If a PR has not been interacted with by a reviewer within one week, please ping the component
188+
owners as listed in [.github/component_owners.yml](.github/component_owners.yml), if component owners are unresponsive
189+
please ping ([@open-telemetry/javascript-approvers](https://github.com/orgs/open-telemetry/teams/javascript-approvers)).
190+
165191
## Contributing Vendor Components
166192

167193
This repo is generally meant for hosting components that work with popular open-source frameworks and tools. However, it is also possible to contribute components specific to a 3rd party vendor in this repo.

0 commit comments

Comments
 (0)