Skip to content

Commit

Permalink
Contributing doc improvements (#2108)
Browse files Browse the repository at this point in the history
* Contributing doc improvements

* Update CONTRIBUTING.md

Co-authored-by: Reiley Yang <[email protected]>

Co-authored-by: Reiley Yang <[email protected]>
  • Loading branch information
cijothomas and reyang authored Jun 25, 2021
1 parent 433007b commit 58a8015
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,14 @@ Open a pull request against the main `opentelemetry-dotnet` repo.

* If the PR is not ready for review, please mark it as
[`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
* Make sure CLA is signed and CI is clear.
* Make sure CLA is signed and all required CI checks are clear.
* Submit small, focused PRs addressing a single
concern/issue.
* Make sure the PR title reflects the contribution.
* Write a summary that helps understand the change.
* Include usage examples in the summary, where applicable.
* Include benchmarks (before/after) in the summary, for contributions that are
performance enhancements.

### How to Get PRs Merged

Expand All @@ -170,6 +177,22 @@ Any Maintainer can merge the PR once it is **ready to merge**. Note, that some
PR may not be merged immediately if repo is being in process of a major release
and the new feature doesn't fit it.

If a PR has been stuck (e.g. there are lots of debates and people couldn't agree
on each other), the owner should try to get people aligned by:

* Consolidating the perspectives and putting a summary in the PR. It is
recommended to add a link into the PR description, which points to a comment
with a summary in the PR conversation.
* Tagging subdomain experts (by looking at the change history) in the PR asking
for suggestion.
* Reaching out to more people on the [CNCF OpenTelemetry .NET Slack
channel](https://cloud-native.slack.com/archives/C01N3BC2W7Q).
* Stepping back to see if it makes sense to narrow down the scope of the PR or
split it up.
* If none of the above worked and the PR has been stuck for more than 2 weeks,
the owner should bring it to the OpenTelemetry .NET SIG
[meeting](README.md#contributing).

## Design Choices

As with other OpenTelemetry clients, opentelemetry-dotnet follows the
Expand Down

0 comments on commit 58a8015

Please sign in to comment.