Skip to content

Commit 6d0c755

Browse files
Copilotwadepickett
andauthored
Update SKILL.md: file naming convention and PR description requirements (#37153)
* Initial plan * Update SKILL.md: file naming convention and PR description requirements Agent-Logs-Url: https://github.com/dotnet/AspNetCore.Docs/sessions/b5cfc3ed-13cb-4124-a283-42ac196468f7 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 801b9b3 commit 6d0c755

1 file changed

Lines changed: 24 additions & 8 deletions

File tree

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

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

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,25 @@ All include files go in:
2323

2424
### File naming convention
2525

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`).
2831
**CRITICAL**: Every new file MUST include the preview suffix. This was a mistake
2932
in the initial automation — a file was created without the suffix and had to be
3033
corrected.
3134
* 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`
3639

3740
### One file per feature
3841

3942
* Create one include file per feature or section.
4043
* **Exception — Performance**: Combine all performance improvements into a
41-
single `performance-improvements-preview{N}.md` file.
44+
single `performance-improvements-preview-{N}.md` file.
4245

4346
### Exclusions — do NOT create include files for
4447

@@ -133,7 +136,8 @@ All include files go in:
133136

134137
Before completing, verify:
135138

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).
137141
- [ ] No Blazor content was included.
138142
- [ ] No bug-fix-only content was included.
139143
- [ ] All `<xref:>` IDs are verified (or explicitly flagged as needing verification).
@@ -148,6 +152,18 @@ Before completing, verify:
148152

149153
---
150154

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.
158+
* Example:
159+
```
160+
Fixes dotnet/AspNetCore.Docs#10000
161+
162+
Summary of changes...
163+
```
164+
165+
---
166+
151167
## Example: Correctly formatted include file
152168

153169
```markdown

0 commit comments

Comments
 (0)