Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow for PRs that would affect Contrib #1382

Merged
merged 4 commits into from
Nov 18, 2020
Merged

Workflow for PRs that would affect Contrib #1382

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7e7b1d
Workflow for PRs that would affect Contrib
NathanielRN Nov 14, 2020
6b48413
Detail guidelines for changing repo SHAs
NathanielRN Nov 17, 2020
1d32504
Merge branch 'master' into core-pr-workflow
Nov 18, 2020
77bfbce
Merge branch 'master' into core-pr-workflow
Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,21 @@ $ git push fork feature

Open a pull request against the main `opentelemetry-python` repo.

Pull requests are also tested for their compatibility with packages distributed
by OpenTelemetry in the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git).

If a pull request introduces a change that would break the compatibility of
these packages with the Core packages in this repo, a separate PR should be
opened in the Contrib repo with changes to make the packages compatible.

Once the pull request in the Contrib repo is open, take note of the commit SHA
and edit the `CONTRIB_SHA` variable found in `.github/workflows/test.yml` to
pass even the Contrib repo tests and so get the Core repo PR green and ready to
merge.
NathanielRN marked this conversation as resolved.
Show resolved Hide resolved

**NOTE:** That Contrib pull request will also have to reference the commit SHA
of this Core pull request to pass its own tests.

### How to Receive Comments

* If the PR is not ready for review, please put `[WIP]` in the title, tag it
Expand All @@ -113,6 +128,8 @@ A PR is considered to be **ready to merge** when:
/ [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)
(at different companies).
* Major feedbacks are resolved.
* All tests are passing, including Contrib Repo tests which may require
updating the GitHub workflow to reference a PR in the Contrib repo
* It has been open for review for at least one working day. This gives people
reasonable time to review.
* Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
Expand Down