Skip to content

Commit 295d3c6

Browse files
committed
Update custom instructions
1 parent 9581ba8 commit 295d3c6

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

.github/instructions/release-notes-writing-instructions.md renamed to .github/instructions/release-notes-writing.instructions.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,39 @@ You are a technical writer assistant tasked with generating release notes for al
3939

4040
## Important Guidelines
4141

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:
4543
- Only document settings that actually exist in VS Code
4644
- Verify all setting names and values before documenting
4745
- Double-check command IDs before referencing them
4846
- Use the search tools to confirm setting/command existence
4947

50-
3. Quality Control:
48+
1. Quality Control:
5149
- Save changes using provided tools
5250
- Verify all links and references
5351
- Ensure consistency with existing docs
5452
- Fact-check all technical details
5553

56-
4. Write to release notes
54+
1. Write to release notes
5755
- Write ONLY the feature documentation sections
5856
- DO NOT include version headers, welcome messages, or update summaries
5957
- Start directly with ### feature headings
6058
- 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.

.github/prompts/generate-release-notes.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
mode: 'agent'
33
tools: ['getCurrentMilestone', 'getReleaseFeatures', 'file_search', 'semantic_search', 'read_file', 'insert_edit_into_file', 'create_file', 'replace_string_in_file', 'fetch_webpage', 'vscode_search_extensions_internal']
44
---
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.
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

Comments
 (0)