Document public release-note and generator evidence rules

[David Burg (daviburg)]

Description

Capture review lessons from the typed-map and Zeptomail SDK PRs so public release notes remain consistent and generator evidence stays in reviewer-facing PR descriptions.

Changes

• For new or edited public changelog and release-note entries, avoid internal BPM repository/PR links; keep generator commits and Swagger provenance in the PR description. Historical entries are out of scope.
• Keep corresponding changelog and release-note entries aligned, and preserve multiline Markdown when creating or updating PR descriptions.
• Test generated request wire contracts against the pinned Swagger operation's request schema, not similarly named response fields or only a mocked success.
• Verify the exact generator commit is in BPM master; a merged generator PR does not include commits pushed to its branch afterward.

Testing

• Focused instruction-content assertions passed.
• git diff --check passed.
• dotnet test not run: instructions-only change.

Checklist

• Code follows repository conventions.
• No generated clients or runtime files changed.
• Documentation updated.
• Changelog and release notes not changed: no user-facing SDK behavior changed.
• Version not updated: not a release PR.

[Copilot]

Copilot review overview

🟡 Changes recommended

The instructions omit the documented workflow for updating existing PR descriptions.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1

Open (1)

• Document preserving multiline Markdown when updating PR descriptions · New

What changed in this PR

Documents review practices for generated SDK validation, release notes, and PR descriptions.

Changes:

• Adds request-schema and generator provenance guidance.
• Adds public release-note consistency rules.
• Documents multiline PR description handling.

File	Description
.github/​copilot-instructions.md	Adds generated-contract and release documentation guidance.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

Copilot review overview

🟢 Approval recommended

The documentation changes are consistent, complete, and address the prior feedback.

Review effort: Balanced
Findings: None

Resolved since last review (1)

• Document preserving multiline Markdown when updating PR descriptions

[Copilot]

Copilot review overview

🟢 Approval recommended

The documentation changes are complete, consistent, and address the prior feedback.

Review effort: Balanced
Findings: None