Skip to content

chore: add PR title guidelines to Contributing.md #5166

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

Open
tammy-baylis-swi wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −5
Open

chore: add PR title guidelines to Contributing.md #5166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 12 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,14 @@ git commit
git push fork feature
```

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

A descriptive PR title will help the community better triage and review your changes. Make sure to prefix with the name(s) of the package/subdirectory/domain that your PR updates. Following any of these examples will help:

* "opentelemetry-sdk: make test_force_flush_late_by_timeout less flaky on pypy/windows"
* "opentelemetry-exporter-otlp-proto-http: enable typechecking"
* "docs: replace TODO placeholders with API and SDK overview descriptions"
* "feat(config): Add TracerProvider support for declarative config"

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).
Expand All @@ -247,12 +254,12 @@ Follow these steps:
1. Open Core repo PR (Contrib Tests will fail)
2. Open Contrib repo PR and modify its `CORE_REPO_SHA` in `.github/workflows/test_x.yml`
to equal the commit SHA of the Core repo PR to pass tests
3. Modify the Core repo PR `CONTRIB_REPO_SHA` in `.github/workflows/test_x.yml` to
1. Modify the Core repo PR `CONTRIB_REPO_SHA` in `.github/workflows/test_x.yml` to
Copy link
Copy Markdown
Contributor

@xrmx xrmx May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why changing the numbers? They are rendered the same

equal the commit SHA of the Contrib repo PR to pass Contrib repo tests (a sanity
check for the Maintainers & Approvers)
4. Merge the Contrib repo
5. Restore the Core repo PR `CONTRIB_REPO_SHA` to point to `main`
6. Merge the Core repo PR
1. Merge the Contrib repo
2. Restore the Core repo PR `CONTRIB_REPO_SHA` to point to `main`
3. Merge the Core repo PR

### How to Receive Comments

Expand Down
Loading