@@ -100,6 +100,24 @@ $ git push fork feature
100100
101101Open a pull request against the main ` opentelemetry-python ` repo.
102102
103+ Pull requests are also tested for their compatibility with packages distributed
104+ by OpenTelemetry in the [ OpenTelemetry Python Contrib Repository] ( https://github.com/open-telemetry/opentelemetry-python.git ) .
105+
106+ If a pull request (PR) introduces a change that would break the compatibility of
107+ these packages with the Core packages in this repo, a separate PR should be
108+ opened in the Contrib repo with changes to make the packages compatible.
109+
110+ Follow these steps:
111+ 1 . Open Core repo PR (Contrib Tests will fail)
112+ 2 . Open Contrib repo PR and modify its ` CORE_REPO_SHA ` in ` .github/workflows/test.yml `
113+ to equal the commit SHA of the Core repo PR to pass tests
114+ 3 . Modify the Core repo PR ` CONTRIB_REPO_SHA ` in ` .github/workflows/test.yml ` to
115+ equal the commit SHA of the Contrib repo PR to pass Contrib repo tests (a sanity
116+ check for the Maintainers & Approvers)
117+ 4 . Merge the Contrib repo
118+ 5 . Restore the Core repo PR ` CONTRIB_REPO_SHA ` to point to ` master `
119+ 6 . Merge the Core repo PR
120+
103121### How to Receive Comments
104122
105123* If the PR is not ready for review, please put ` [WIP] ` in the title, tag it
@@ -113,6 +131,8 @@ A PR is considered to be **ready to merge** when:
113131 / [ Maintainers] ( https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer )
114132 (at different companies).
115133* Major feedbacks are resolved.
134+ * All tests are passing, including Contrib Repo tests which may require
135+ updating the GitHub workflow to reference a PR in the Contrib repo
116136* It has been open for review for at least one working day. This gives people
117137 reasonable time to review.
118138* Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
0 commit comments