From 559b525ab1a73e6c6c21c35cde3e350592e6bf95 Mon Sep 17 00:00:00 2001 From: Nathaniel Ruiz Nowell Date: Tue, 17 Nov 2020 09:17:31 -0800 Subject: [PATCH] Detail guidelines for changing repo SHAs --- CONTRIBUTING.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 949453f5378..9148db8ea80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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