Skip to content

Commit 68c64ee

Browse files
Copilotwadepickett
andauthored
Add content fidelity/preservation rule to the What's New include SKILL file (#37552)
* Initial plan * Add content fidelity/preservation rules to What's New SKILL.md Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
1 parent d9c881b commit 68c64ee

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

  • .github/skills/whats-new-include-content-rules

.github/skills/whats-new-include-content-rules/SKILL.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,33 @@ All include files go in:
5959

6060
## Content rules
6161

62+
### Content fidelity — preserve information; do not condense
63+
64+
The What's New article is a **faithful, cumulative** rendering of the source
65+
release notes. Reformat and de-duplicate, but do not summarize away information.
66+
67+
* **Default to preserving all substantive content** from the source section:
68+
every code example, every explanatory sentence, and the reasoning that
69+
connects prose to code. Transfer them into the include file.
70+
* **Never drop one of a set of parallel examples.** If the source shows a
71+
pattern more than once (for example, an attribute-based example *and* an
72+
object-based example), keep **all** of them. Dropping one often removes the
73+
context that makes the others understandable.
74+
* **Keep "why," not just "what."** If the source explains the rationale for a
75+
code construct (for example, why a synchronous method throws), preserve that
76+
explanation next to the code. A code sample must never be left in a state
77+
where it looks contradictory or pointless without its original explanation.
78+
* **Self-containment check:** after writing each include, re-read it in
79+
isolation. If any code sample would look counterintuitive or unexplained to a
80+
reader who has not seen the source notes, restore the missing explanation or
81+
example from the source.
82+
* **You MAY combine overlapping content across previews** so the cumulative
83+
article doesn't repeat itself, but only remove text that is genuinely
84+
redundant — never text that carries unique information or reasoning.
85+
* **When in doubt, keep it.** Prefer transferring the source wording over
86+
rewriting it more tersely. Condensing is only acceptable when it removes
87+
literal duplication.
88+
6289
### Heading level
6390

6491
* Use `###` (H3) headings — never `#` or `##`. Include files are embedded inside
@@ -149,6 +176,11 @@ Before completing, verify:
149176
- [ ] Community contributor acknowledgments are preserved.
150177
- [ ] Breaking Change designations are preserved in headings.
151178
- [ ] No preview-specific language, such as a preview number, appears in include file content.
179+
- [ ] Every code example from the source section is present (none dropped).
180+
- [ ] All parallel/paired examples from the source are retained together.
181+
- [ ] The rationale ("why") for any non-obvious code construct is preserved next to the code.
182+
- [ ] Each include reads correctly in isolation — no code sample looks counterintuitive without the source.
183+
- [ ] Content removed relative to the source is limited to genuine cross-preview duplication.
152184

153185
---
154186

0 commit comments

Comments
 (0)