diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index db3894622..2105aad48 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,17 @@ ## Testing +## Telemetry Errors + +- [ ] Not applicable — this PR does not add or change a telemetry-visible error. +- [ ] Applicable — the error uses `DatabricksDriverErrorCode` where appropriate, and any + new code is uniquely numbered and tested. +- [ ] Applicable — its driver/server/user classification is linked, or maintainer help is + requested because the author cannot access the classification. + ## Additional Notes to the Reviewer - diff --git a/CLAUDE.md b/CLAUDE.md index b6b803ef1..9b9b83113 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -14,6 +14,19 @@ - `src/test/java/com/databricks/jdbc/` — unit and integration tests - `development/.release-freeze.json` — controls release freeze state +## Telemetry Error Changes + +When adding or changing an error emitted by the JDBC driver: + +- Use `DatabricksDriverErrorCode` wherever a driver-owned error code applies. Reuse an + existing code when its meaning matches; otherwise add a uniquely numbered enum value. +- Add or update a test that verifies the emitted error name and numeric code. +- Record whether the error is a driver, server, or user error in the maintainers' OSS JDBC + telemetry dashboard and automation taxonomy. Link that update in the PR, or explicitly + ask a maintainer to make it if you do not have access. Do not infer the classification + from the error name alone. +- Complete the telemetry-error section of the pull-request template. + ## PR Checks — Common Pitfalls ### 1. DCO Sign-off (required)