Skip to content

Commit

Permalink
Use PR number as OTEP id. (open-telemetry#4292)
Browse files Browse the repository at this point in the history
Co-authored-by: Armin Ruech <[email protected]>
  • Loading branch information
carlosalberto and arminru authored Nov 14, 2024
1 parent f599c40 commit ca2a0d4
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion oteps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,12 @@ For example, an OTEP proposing configurable sampling *and* various samplers shou

- First, [fork](https://help.github.com/en/articles/fork-a-repo) this repo.
- Copy [`0000-template.md`](./0000-template.md) to `0000-my-OTEP.md`, where `my-OTEP` is a title relevant to your proposal, and `0000` is the OTEP ID.
Leave the number as is for now. Once a Pull Request is made, update this ID to match the PR ID.
- Fill in the template. Put care into the details: It is important to present convincing motivation, demonstrate an understanding of the design's impact, and honestly assess the drawbacks and potential alternatives.

### Submitting the OTEP

- An OTEP is `proposed` by posting it as a PR.
- An OTEP is `proposed` by posting it as a PR. Once the PR is created, update the OTEP file name to use the PR ID as the OTEP ID.
- An OTEP is `approved` when four reviewers github-approve the PR. The OTEP is then merged.
- If an OTEP is `rejected` or `withdrawn`, the PR is closed. Note that these OTEPs submissions are still recorded, as GitHub retains both the discussion and the proposal, even if the branch is later deleted.
- If an OTEP discussion becomes long, and the OTEP then goes through a major revision, the next version of the OTEP can be posted as a new PR, which references the old PR. The old PR is then closed. This makes OTEP review easier to follow and participate in.
Expand Down

0 comments on commit ca2a0d4

Please sign in to comment.