You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/skills/whats-new-include-content-rules/SKILL.md
+24-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,22 +23,25 @@ All include files go in:
23
23
24
24
### File naming convention
25
25
26
-
* Lowercase, hyphenated, descriptive names.
27
-
* Append the preview number suffix to each filename: `-preview{N}` (where `{N}` is the preview number, e.g., `-preview2`).
26
+
* Lowercase, hyphenated, descriptive names using whole words only.
27
+
* Each word and number must be separated by a hyphen. Do not combine words or abbreviate them, and do not combine numbers with words.
28
+
-**Wrong**: `infer-pk-display-name-preview2.md` (`pk` is an abbreviation, and `preview2` combines a word with a number)
29
+
-**Correct**: `infer-passkey-display-name-preview-2.md` (whole words, number separated by hyphen)
30
+
* Append the preview number suffix to each filename: `-preview-{N}` (where `{N}` is the preview number, e.g., `-preview-2`).
28
31
**CRITICAL**: Every new file MUST include the preview suffix. This was a mistake
29
32
in the initial automation — a file was created without the suffix and had to be
30
33
corrected.
31
34
* Examples:
32
-
-`native-otel-tracing-preview2.md`
33
-
-`openapi-3-2-support-preview2.md`
34
-
-`infer-passkey-display-name-preview2.md`
35
-
-`performance-improvements-preview2.md`
35
+
-`native-otel-tracing-preview-2.md`
36
+
-`openapi-3-2-support-preview-2.md`
37
+
-`infer-passkey-display-name-preview-2.md`
38
+
-`performance-improvements-preview-2.md`
36
39
37
40
### One file per feature
38
41
39
42
* Create one include file per feature or section.
40
43
***Exception — Performance**: Combine all performance improvements into a
41
-
single `performance-improvements-preview{N}.md` file.
44
+
single `performance-improvements-preview-{N}.md` file.
42
45
43
46
### Exclusions — do NOT create include files for
44
47
@@ -133,7 +136,8 @@ All include files go in:
133
136
134
137
Before completing, verify:
135
138
136
-
-[ ] Every new include filename ends with `-preview{N}`.
139
+
-[ ] Every new include filename ends with `-preview-{N}`.
140
+
-[ ] Every word and number in filenames is separated by a hyphen (no abbreviations, no combined word-numbers).
137
141
-[ ] No Blazor content was included.
138
142
-[ ] No bug-fix-only content was included.
139
143
-[ ] All `<xref:>` IDs are verified (or explicitly flagged as needing verification).
@@ -148,6 +152,18 @@ Before completing, verify:
148
152
149
153
---
150
154
155
+
## PR description requirements
156
+
157
+
* The very first line of the PR description must be `Fixes dotnet/AspNetCore.Docs#{ISSUE NUMBER}` (where `{ISSUE NUMBER}` is the number of the issue this PR addresses), followed by a blank line before any other content.
0 commit comments