diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 820c0f3e104..0eecffd778b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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).