Skip to content

Commit de79c5d

Browse files
Harden changelog/What's New rules in copilot-instructions (#28932)
- Surface ask-first step for schema changes (additions, updates, deprecations, retirements) at the routing level - Rewrite rule 11 to default-on: omit changelog/What's New only with explicit author confirmation; remove 'may require' and 'customer-visible' escape hatches - Broaden Common change pattern from new-beta-only to all schema change types across both beta and v1.0 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 470284d commit de79c5d

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

.github/copilot-instructions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Before doing any docs work, determine the task type and read the matching prompt
88

99
- **Authoring or updating docs:** read `.github/prompts/author-api-docs.prompt.md`
1010
- **Reviewing docs changes:** read `.github/prompts/review-api-docs.prompt.md`
11+
- **Schema changes (additions, updates, deprecations, or retirements of any property, resource, method, enum, or enum member):** Before starting work, ask the author whether a changelog entry and What's New update are needed. Default to yes unless told otherwise.
1112

1213
Then read the scenario-specific files that those prompt files direct you to use.
1314

@@ -81,7 +82,7 @@ These rules apply across authoring and review scenarios:
8182
8. **API and resource topics must keep the standard section order** for their file type.
8283
9. **Tables must preserve required ordering rules**, including alphabetical ordering where the detailed guidance requires it.
8384
10. **Enum changes must be checked across all exposed documentation surfaces**, not only the enum definition itself.
84-
11. **Customer-visible API changes require changelog review and may require What's New updates.**
85+
11. **Schema changes — additions, updates, deprecations, and retirements of any property, resource, method, or enum member — require a changelog entry and What's New update. Omit either only with explicit author confirmation.**
8586

8687
## Core standards
8788

@@ -113,7 +114,7 @@ Use the linked prompt files for the full standards. The rules below are the most
113114

114115
## Common change patterns
115116

116-
- **New schema in beta:** update affected API/resource docs, enum docs, changelog, TOC, and What's New if the change is customer-visible.
117+
- **Schema changes (additions, updates, deprecations, retirements):** update affected API/resource docs, enum docs, changelog, TOC, and What's New. Omit changelog or What's New only with explicit author confirmation.
117118
- **Promotion to v1.0:** use the GA workflow, keep beta and v1.0 aligned where intended, remove beta-only content, update changelog, and add a What's New entry.
118119
- **Enum member additions:** update the enum definition, any inline value listings, and every API/resource page that enumerates supported values.
119120
- **Deprecation or retirement:** update banners and table entries, related references, changelog, What's New, redirects, and TOC as applicable.

0 commit comments

Comments
 (0)