@@ -4,7 +4,7 @@ ms.author: wpickett
44ms.date : 11-13-2025
55---
66
7- # GitHub Issue Analysis and Action Plan Prompt for ASP.NET Core Documentation
7+ # GitHub issue analysis and action plan prompt for ASP.NET Core documentation
88
99## Goal
1010Analyze the GitHub issue and provide a ** structured report** determining:
@@ -20,38 +20,38 @@ The report should be suitable for posting directly in the issue discussion.
2020
2121### 1. Information Gathering
2222Collect and review:
23- - The ** issue title, description, and all comments**
24- - The ** published documentation** (via the provided URL)
25- - The ** source file(s)** in the repository
26- - Any ** linked issues, PRs, or external references**
27- - ** Environment details** : .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.)
28- - ** Code samples or error messages** mentioned in the issue
23+ * The ** issue title, description, and all comments**
24+ * The ** published documentation** (via the provided URL)
25+ * The ** source file(s)** in the repository
26+ * Any ** linked issues, PRs, or external references**
27+ * ** Environment details** : .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.)
28+ * ** Code samples or error messages** mentioned in the issue
2929
3030### 1.5 Source File Analysis
3131When examining source files:
32- - ** Provide direct GitHub permalinks** to specific lines or sections
33- - ** Note exact line numbers** for proposed changes
34- - ** Include line number ranges** in GitHub URLs using ` #L<start>-L<end> ` format
35- - ** Quote current content** from specific lines before proposing changes
36- - ** Use permalinks with commit SHA** when referencing specific versions
32+ * ** Provide direct GitHub permalinks** to specific lines or sections
33+ * ** Note exact line numbers** for proposed changes
34+ * ** Include line number ranges** in GitHub URLs using ` #L<start>-L<end> ` format
35+ * ** Quote current content** from specific lines before proposing changes
36+ * ** Use permalinks with commit SHA** when referencing specific versions
3737
3838Example format for file references:
39- - Single line: ` https://github.com/owner/repo/blob/main/file.md#L123 `
40- - Line range: ` https://github.com/owner/repo/blob/main/file.md#L123-L145 `
41- - Permalink: ` https://github.com/owner/repo/blob/<commit-sha>/file.md#L123 `
39+ * Single line: ` https://github.com/owner/repo/blob/main/file.md#L123 `
40+ * Line range: ` https://github.com/owner/repo/blob/main/file.md#L123-L145 `
41+ * Permalink: ` https://github.com/owner/repo/blob/<commit-sha>/file.md#L123 `
4242
4343### 2. Validation Criteria
4444Determine if the issue is:
45- - ** In scope** : Related to ASP.NET Core documentation (not product bugs)
46- - ** Accurate** : The reported problem genuinely exists
47- - ** Clear** : Sufficient information to take action
48- - ** Current** : Applies to supported .NET versions
45+ * ** In scope** : Related to ASP.NET Core documentation (not product bugs)
46+ * ** Accurate** : The reported problem genuinely exists
47+ * ** Clear** : Sufficient information to take action
48+ * ** Current** : Applies to supported .NET versions
4949
5050### 3. Translation Requirements
5151If any content is not in English:
52- - Include the original text in a quote block
53- - Provide complete English translation
54- - Label clearly as "Original" and "Translation"
52+ * Include the original text in a quote block
53+ * Provide complete English translation
54+ * Label clearly as "Original" and "Translation"
5555
5656---
5757
@@ -123,25 +123,25 @@ If any content is not in English:
123123
124124## 🎯 Action Plan
1251251 . ** Edit file:** [ ` aspnetcore/path/to/file.md ` ] ( https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md )
126- - Navigate to: [ Line 123] ( https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123 )
127- - Find section: "Exact Section Heading"
128- - After text: "last sentence before insertion point"
129- - Insert: [ !NOTE] block with explanation
126+ * Navigate to: [ Line 123] ( https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123 )
127+ * Find section: "Exact Section Heading"
128+ * After text: "last sentence before insertion point"
129+ * Insert: [ !NOTE] block with explanation
130130
1311312 . ** Update sample:** [ ` path/to/sample.cs ` ] ( https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs )
132- - Navigate to: [ Lines 45-67] ( https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs#L45-L67 )
133- - Modify method: ` MethodName() `
134- - Change: Update to use new pattern
132+ * Navigate to: [ Lines 45-67] ( https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs#L45-L67 )
133+ * Modify method: ` MethodName() `
134+ * Change: Update to use new pattern
135135
136136## ⚠️ Considerations
137- - Verify change applies to .NET [ version]
138- - Check if similar updates needed in related articles
139- - Consider adding cross-references to [ related topic]
137+ * Verify change applies to .NET [ version]
138+ * Check if similar updates needed in related articles
139+ * Consider adding cross-references to [ related topic]
140140
141141## 🔗 References
142- - Published article: [ URL]
143- - Related issue: #[ number]
144- - Microsoft Learn docs: [ relevant MS docs link]
142+ * Published article: [ URL]
143+ * Related issue: #[ number]
144+ * Microsoft Learn docs: [ relevant MS docs link]
145145```
146146
147147#### For Invalid Issues
@@ -157,56 +157,56 @@ If any content is not in English:
157157<Clear explanation of why the issue cannot be addressed as documentation>
158158
159159## 💡 Recommendation
160- - [Close with explanation]
161- - [Redirect to appropriate repository]
162- - [Request additional information]
163- - [Convert to discussion]
160+ * [Close with explanation]
161+ * [Redirect to appropriate repository]
162+ * [Request additional information]
163+ * [Convert to discussion]
164164
165165## 🔗 Alternative Resources
166- - [Link to relevant documentation]
167- - [Link to appropriate repository for product issues]
166+ * [Link to relevant documentation]
167+ * [Link to appropriate repository for product issues]
168168```
169169
170170---
171171
172172## Special Instructions
173173
174174### Line Number Guidelines
175- - ** Always inspect the actual source file** to determine accurate line numbers
176- - ** Provide line ranges** rather than single lines when changes affect multiple lines
177- - ** Use GitHub's line highlighting** format in URLs (#L123 for single, #L123-L145 for range)
178- - ** Quote the existing content** at those lines to confirm accuracy
179- - ** Consider context lines** - include a few lines before/after for clarity
180- - ** Update line numbers** if the file has changed since issue creation
175+ * ** Always inspect the actual source file** to determine accurate line numbers
176+ * ** Provide line ranges** rather than single lines when changes affect multiple lines
177+ * ** Use GitHub's line highlighting** format in URLs (#L123 for single, #L123-L145 for range)
178+ * ** Quote the existing content** at those lines to confirm accuracy
179+ * ** Consider context lines** - include a few lines before/after for clarity
180+ * ** Update line numbers** if the file has changed since issue creation
181181
182182### Content Block Usage
183183Only recommend using special blocks when truly appropriate, they should not be overused:
184- - ` [!IMPORTANT] ` : Security issues, breaking changes, data loss risks
185- - ` [!WARNING] ` : Common mistakes, deprecation notices
186- - ` [!NOTE] ` : Helpful clarifications, version-specific info
187- - ` [!TIP] ` : Best practices, productivity hints
184+ * ` [!IMPORTANT] ` : Security issues, breaking changes, data loss risks
185+ * ` [!WARNING] ` : Common mistakes, deprecation notices
186+ * ` [!NOTE] ` : Helpful clarifications, version-specific info
187+ * ` [!TIP] ` : Best practices, productivity hints
188188
189189### Code Samples
190- - Use appropriate language identifier for syntax highlighting
191- - Include necessary ` using ` statements or imports
192- - Add comments for complex logic
193- - Ensure samples are complete and runnable
190+ * Use appropriate language identifier for syntax highlighting
191+ * Include necessary ` using ` statements or imports
192+ * Add comments for complex logic
193+ * Ensure samples are complete and runnable
194194
195195### Scope Boundaries
196196** DO:**
197- - Focus on documentation clarity and accuracy
198- - Address missing information
199- - Fix technical inaccuracies
200- - Improve code samples
197+ * Focus on documentation clarity and accuracy
198+ * Address missing information
199+ * Fix technical inaccuracies
200+ * Improve code samples
201201
202202** DON'T:**
203- - Attempt to fix product bugs through documentation
204- - Make architectural recommendations
205- - Add opinions or preferences
206- - Modify unrelated sections
203+ * Attempt to fix product bugs through documentation
204+ * Make architectural recommendations
205+ * Add opinions or preferences
206+ * Modify unrelated sections
207207
208208## Issue labels
209- - Upon completion of the report, set the ` ai-reviewed-issue-reported-action-plan ` label for the issue.
209+ * Upon completion of the report, set the ` ai-reviewed-issue-reported-action-plan ` label for the issue.
210210
211211### Common Issue Types
2122121 . ** Missing information** : Add clarifying content
0 commit comments