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/instructions/release-notes-writing.instructions.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,23 +39,39 @@ You are a technical writer assistant tasked with generating release notes for al
39
39
40
40
## Important Guidelines
41
41
42
-
1. Use [General Writing Guidelines](../copilot-instructions.md) file as a reference for writing guidelines
43
-
44
-
2. Settings and Commands:
42
+
1. Settings and Commands:
45
43
- Only document settings that actually exist in VS Code
46
44
- Verify all setting names and values before documenting
47
45
- Double-check command IDs before referencing them
48
46
- Use the search tools to confirm setting/command existence
49
47
50
-
3. Quality Control:
48
+
1. Quality Control:
51
49
- Save changes using provided tools
52
50
- Verify all links and references
53
51
- Ensure consistency with existing docs
54
52
- Fact-check all technical details
55
53
56
-
4. Write to release notes
54
+
1. Write to release notes
57
55
- Write ONLY the feature documentation sections
58
56
- DO NOT include version headers, welcome messages, or update summaries
59
57
- Start directly with ### feature headings
60
58
- Use the write tools to write to the release notes
61
-
- Do not ask for user confirmation
59
+
- Do not ask for user confirmation
60
+
61
+
## Writing Guidelines
62
+
63
+
Apply these specific guidelines to all release notes. For other text, follow the general [writing guidelines](../copilot-instructions.md).
64
+
65
+
### Headings
66
+
67
+
- Don't apply an inline style like italic, bold, or inline code style to headings.
68
+
- Lowercase everything except the first word in a heading.
69
+
70
+
### Links
71
+
72
+
- Links to other documentation articles should be absolute, not relative. Start absolute links with `https://code.visualstudio.com/docs/` and don't include the `.md` suffix.
73
+
- Link text should be descriptive and clearly indicate the content of the linked article. Don't use "click here" or "this link" or "here".
74
+
75
+
### Text Formatting
76
+
77
+
- Notes and tips are formatted as block quotes with the word "Note" or "Tip" in bold at the start of the line. Don't use alert-style formatting for these.
Generate release notes for the features I worked in the current release and update them in the release notes file. Use [release notes writing instructions file](.github/instructions/release-notes-writing-instructions.md) #file:.github/instructions/release-notes-writing-instructions.md as a guide.
5
+
Generate release notes for the features I worked in the current release and update them in the release notes file. Use [release notes writing instructions file](.github/instructions/release-notes-writing.instructions.md) #file:.github/instructions/release-notes-writing.instructions.md as a guide.
0 commit comments