diff --git a/.github/PULL_REQUEST_TEMPLATE.MD b/.github/PULL_REQUEST_TEMPLATE.MD index 61fa0e65..79dac291 100644 --- a/.github/PULL_REQUEST_TEMPLATE.MD +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -16,6 +16,33 @@ Only one reference is required - either GitHub issue OR ADO Work Item. ### Summary + comment markers around this block (and optionally these +instruction/separator lines), then fill in the `## Rust Changes ...` section +below. It is used to auto-generate Python release notes — every +customer-facing change from the Rust side must be listed here so it is not +lost at release time. +============================================================================= + +## Rust Changes (mssql-py-core X.X.X → X.X.X) + +### Features +- **Feature name** — One sentence: what was added and why it matters to Python users. + +### Bug Fixes +- **Fix name** — One sentence: what was broken and what is now correct. + +### Performance +- **Improvement name** — One sentence: what got faster/lighter and in which scenario. + +> Tip: omit internal Rust refactors, CI-only changes, and test-only changes. +> Link Rust PRs using full URL: https://github.com/microsoft/mssql-rs/pull/N +============================================================================= +--> +