Skip to content

Commit

Permalink
Detail guidelines for changing repo SHAs
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanielRN committed Nov 17, 2020
1 parent d7e7b1d commit 559b525
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,21 @@ 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
If a pull request (PR) 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.

**NOTE:** That Contrib pull request will also have to reference the commit SHA
of this Core pull request to pass its own tests.
Follow these steps:
1. Open Core repo PR (Contrib Tests will fail)
2. Open Contrib repo PR
3. Modify the Core repo PR `CONTRIB_REPO_SHA` in `.github/workflows/test.yml` to
equal the commit SHA of the Contrib repo PR to pass Contrib repo tests (a sanity
check for the Maintainers & Approvers)
4. Modify the Contrib repo PR `CORE_REPO_SHA` to equal the commit SHA of the
Core repo PR to pass tests
5. Merge the Contrib repo
6. Restore the Core repo PR `CONTRIB_REPO_SHA` to point to `master`
7. Merge the Core repo PR

### How to Receive Comments

Expand Down

0 comments on commit 559b525

Please sign in to comment.