-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore] Update contributing guidelines (#134)
* update contributing PR guidelines and approvers & maintainers * update pr requirements
- Loading branch information
1 parent
b99f423
commit f9f5153
Showing
1 changed file
with
142 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,15 @@ | ||
| # Contributing | ||
| # Contributing to opentelemetry-go-instrumentation | ||
|
|
||
| Please help us build this project! | ||
| The Go Instrumnentation special interest group (SIG) meets regularly. See the | ||
| OpenTelemetry | ||
| [community](https://github.com/open-telemetry/community) | ||
| repo for information on this and other language SIGs. | ||
|
|
||
| ## Community meetings | ||
|
|
||
| Join our bi-weekly meetings if you would like to connect with us via zoom. | ||
| You can find them on the [OpenTelemetry calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com&ctz=America%2FLos_Angeles). | ||
|
|
||
| ## Slack | ||
|
|
||
| Comments and questions about the project can be posted in our [slack channel](https://cloud-native.slack.com/archives/C03S01YSAS0). | ||
| See the [public meeting | ||
| notes](https://docs.google.com/document/d/1P6am_r_cxCX1HcpDQlznrTrTOvwN2whshL0f58lXSWI/edit) | ||
| for a summary description of past meetings. To request edit access, | ||
| join the meeting or get in touch on | ||
| [Slack](https://cloud-native.slack.com/archives/C03S01YSAS0). | ||
|
|
||
| ## Development | ||
|
|
||
|
|
@@ -18,26 +18,145 @@ Comments and questions about the project can be posted in our [slack channel](ht | |
| Linux users can build this repository by running: | ||
| `make build` | ||
|
|
||
| Windows/Mac users will need to compile this project inside a docker container by running: | ||
| `make docker-build IMG=otel-go-agent:v0.1` | ||
| Windows/Mac users will need to compile this project inside a Linux docker container by running: | ||
| `make docker-build` | ||
|
|
||
| ### Issues | ||
|
|
||
| Questions, bug reports, and feature requests can all be submitted as [issues](https://github.com/open-telemetry/opentelemetry-go-instrumentation/issues/new) to this repository. | ||
|
|
||
| ### Pull Requests | ||
| ## Pull Requests | ||
|
|
||
| ### How to Send Pull Requests | ||
|
|
||
| Everyone is welcome to contribute code to `opentelemetry-go-instrumentation` via | ||
| GitHub pull requests (PRs). | ||
|
|
||
| To create a new PR, fork the project in GitHub and clone the upstream | ||
| repo: | ||
|
|
||
| ```sh | ||
| go get -d go.opentelemetry.io/auto | ||
| ``` | ||
|
|
||
| (This may print some warning about "build constraints exclude all Go | ||
| files", just ignore it.) | ||
|
|
||
| This will put the project in `${GOPATH}/src/go.opentelemetry.io/auto`. You | ||
| can alternatively use `git` directly with: | ||
|
|
||
| ```sh | ||
| git clone https://github.com/open-telemetry/opentelemetry-go-instrumentation | ||
| ``` | ||
|
|
||
| (Note that `git clone` is *not* using the `go.opentelemetry.io/auto` name - | ||
| that name is a kind of a redirector to GitHub that `go get` can | ||
| understand, but `git` does not.) | ||
|
|
||
| This would put the project in the `opentelemetry-go-instrumentation` directory in | ||
| current working directory. | ||
|
|
||
| Enter the newly created directory and add your fork as a new remote: | ||
|
|
||
| ```sh | ||
| git remote add <YOUR_FORK> [email protected]:<YOUR_GITHUB_USERNAME>/opentelemetry-go-instrumentation | ||
| ``` | ||
|
|
||
| Check out a new branch, make modifications, run linters and tests, update | ||
| `CHANGELOG.md`, and push the branch to your fork: | ||
|
|
||
| ```sh | ||
| git checkout -b <YOUR_BRANCH_NAME> | ||
| # edit files | ||
| # update changelog | ||
| make precommit | ||
| git add -p | ||
| git commit | ||
| git push <YOUR_FORK> <YOUR_BRANCH_NAME> | ||
| ``` | ||
|
|
||
| Open a pull request against the main `opentelemetry-go-instrumentation` repo. Be sure to add the pull | ||
| request ID to the entry you added to `CHANGELOG.md`. | ||
|
|
||
| ### How to Receive Comments | ||
|
|
||
| * If the PR is not ready for review, please put `[WIP]` in the title, | ||
| tag it as `work-in-progress`, or mark it as | ||
| [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/). | ||
| * Make sure CLA is signed and CI is clear. | ||
|
|
||
| ### How to Get PRs Merged | ||
|
|
||
| A PR is considered **ready to merge** when: | ||
|
|
||
| Development of this repository is done using the [forking model](https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
| * It has received two qualified approvals[^1]. | ||
|
|
||
| Once you have changes on a branch of your fork that you would like to proposed to this project [create a pull request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). | ||
| If you are still working to finalize your PR, but would like to publish something publicly, create the PR as a draft. | ||
| This is not enforced through automation, but needs to be validated by the | ||
| maintainer merging. | ||
| * The qualified approvals need to be from [Approver]s/[Maintainer]s | ||
| affiliated with different companies. Two qualified approvals from | ||
| [Approver]s or [Maintainer]s affiliated with the same company counts as a | ||
| single qualified approval. | ||
| * PRs introducing changes that have already been discussed and consensus | ||
| reached only need one qualified approval. The discussion and resolution | ||
| needs to be linked to the PR. | ||
| * Trivial changes[^2] only need one qualified approval. | ||
|
|
||
| Next, your PR needs to be reviewed and approved by the [project approvers](https://github.com/orgs/open-telemetry/teams/go-instrumentation-approvers). | ||
| It will be ready to merge when: | ||
| * All feedback has been addressed. | ||
| * All PR comments and suggestions are resolved. | ||
| * All GitHub Pull Request reviews with a status of "Request changes" have | ||
| been addressed. Another review by the objecting reviewer with a different | ||
| status can be submitted to clear the original review, or the review can be | ||
| dismissed by a [Maintainer] when the issues from the original review have | ||
| been addressed. | ||
| * Any comments or reviews that cannot be resolved between the PR author and | ||
| reviewers can be submitted to the community [Approver]s and [Maintainer]s | ||
| during the weekly SIG meeting. If consensus is reached among the | ||
| [Approver]s and [Maintainer]s during the SIG meeting the objections to the | ||
| PR may be dismissed or resolved or the PR closed by a [Maintainer]. | ||
| * Any substantive changes to the PR require existing Approval reviews be | ||
| cleared unless the approver explicitly states that their approval persists | ||
| across changes. This includes changes resulting from other feedback. | ||
| [Approver]s and [Maintainer]s can help in clearing reviews and they should | ||
| be consulted if there are any questions. | ||
|
|
||
| - It has received two approvals from project approvers (at different companies). | ||
| - All feedback has been addressed. | ||
| - All open comments should be resolved. | ||
| * The PR branch is up to date with the base branch it is merging into. | ||
| * To ensure this does not block the PR, it should be configured to allow | ||
| maintainers to update it. | ||
|
|
||
| A [project maintainer](https://github.com/orgs/open-telemetry/teams/go-instrumentation-maintainers) can merge the PR once these conditions are satisfied. | ||
| It is up to project maintains to ensure enough time has been allowed for review of PRs. | ||
| * All required GitHub workflows have succeeded. | ||
| * Urgent fix can take exception as long as it has been actively communicated | ||
| among [Maintainer]s. | ||
|
|
||
| Any [Maintainer] can merge the PR once the above criteria have been met. | ||
|
|
||
| [^1]: A qualified approval is a GitHub Pull Request review with "Approve" | ||
| status from an OpenTelemetry Go [Approver] or [Maintainer]. | ||
| [^2]: Trivial changes include: typo corrections, cosmetic non-substantive | ||
| changes, documentation corrections or updates, dependency updates, etc. | ||
|
|
||
| ## Appovers and Maintainers | ||
|
|
||
| ### Approvers | ||
|
|
||
| - [Dinesh Gurumurthy](https://github.com/dineshg13), DataDog | ||
| - [Mike Dame](https://github.com/damemi), Google | ||
| - [Mike Goldsmith](https://github.com/MikeGoldsmith), Honeycomb | ||
| - [Robert Pająk](https://github.com/pellared), Splunk | ||
|
|
||
| ### Maintainers | ||
|
|
||
| - [Aaron Clawson](https://github.com/MadVikingGod), LightStep | ||
| - [Anthony Mirabella](https://github.com/Aneurysm9), AWS | ||
| - [Eden Federman](https://github.com/edeNFed), KeyVal | ||
| - [Joshua MacDonald](https://github.com/jmacd), LightStep | ||
| - [Przemyslaw Delewski](https://github.com/pdelewski), SumoLogic | ||
| - [Tyler Yahn](https://github.com/MrAlias), Splunk | ||
|
|
||
| ### Become an Approver or a Maintainer | ||
|
|
||
| See the [community membership document in OpenTelemetry community | ||
| repo](https://github.com/open-telemetry/community/blob/main/community-membership.md). | ||
|
|
||
| [Approver]: #approvers | ||
| [Maintainer]: #maintainers | ||