Skip to content

Commit 3d1a99e

Browse files
committed
Removed quick decision tree
1 parent e3b9f62 commit 3d1a99e

File tree

1 file changed

+43
-56
lines changed

1 file changed

+43
-56
lines changed

.github/copilot-issue-verification-action-plan.md

Lines changed: 43 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ ms.date: 11-13-2025
88

99
## Goal
1010
Analyze the GitHub issue and provide a **structured report** determining:
11-
1. Whether the issue is valid and actionable
12-
2. The exact documentation changes required (if applicable)
13-
3. A clear action plan that can guide PR creation
11+
1. Whether the issue is valid and actionable.
12+
1. Whether the issue is whithin scope of the articles the issue relates to, or if a new article is needed.
13+
1. The exact documentation changes required (if applicable).
14+
1. A clear action plan that can guide PR creation.
1415

1516
The report should be suitable for posting directly in the issue discussion.
1617

@@ -20,38 +21,38 @@ The report should be suitable for posting directly in the issue discussion.
2021

2122
### 1. Information Gathering
2223
Collect 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
24+
* The **issue title, description, and all comments**.
25+
* The **published documentation** (via the provided URL).
26+
* The **source file(s)** in the repository.
27+
* Any **linked issues, PRs, or external references**.
28+
* **Environment details**: .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.).
29+
* **Code samples or error messages** mentioned in the issue.
2930

3031
### 1.5 Source File Analysis
3132
When 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
33+
* **Provide direct GitHub permalinks** to specific lines or sections.
34+
* **Note exact line numbers** for proposed changes.
35+
* **Include line number ranges** in GitHub URLs using `#L<start>-L<end>` format.
36+
* **Quote current content** from specific lines before proposing changes.
37+
* **Use permalinks with commit SHA** when referencing specific versions.
3738

3839
Example 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`
40+
* Single line: `https://github.com/owner/repo/blob/main/file.md#L123`.
41+
* Line range: `https://github.com/owner/repo/blob/main/file.md#L123-L145`.
42+
* Permalink: `https://github.com/owner/repo/blob/<commit-sha>/file.md#L123`.
4243

4344
### 2. Validation Criteria
4445
Determine 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
46+
* **In scope**: Related to ASP.NET Core documentation (not product bugs).
47+
* **Accurate**: The reported problem genuinely exists.
48+
* **Clear**: Sufficient information to take action.
49+
* **Current**: Applies to supported .NET versions.
4950

5051
### 3. Translation Requirements
5152
If 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"
53+
* Include the original text in a quote block.
54+
* Provide complete English translation.
55+
* Label clearly as "Original" and "Translation".
5556

5657
---
5758

@@ -172,12 +173,12 @@ If any content is not in English:
172173
## Special Instructions
173174

174175
### 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
176+
* **Always inspect the actual source file** to determine accurate line numbers.
177+
* **Provide line ranges** rather than single lines when changes affect multiple lines.
178+
* **Use GitHub's line highlighting** format in URLs (#L123 for single, #L123-L145 for range).
179+
* **Quote the existing content** at those lines to confirm accuracy.
180+
* **Consider context lines** - include a few lines before/after for clarity.
181+
* **Update line numbers** if the file has changed since issue creation.
181182

182183
### Content Block Usage
183184
Only recommend using special blocks when truly appropriate, they should not be overused:
@@ -187,23 +188,23 @@ Only recommend using special blocks when truly appropriate, they should not be o
187188
* `[!TIP]`: Best practices, productivity hints
188189

189190
### 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
191+
* Use appropriate language identifier for syntax highlighting.
192+
* Include necessary `using` statements or imports.
193+
* Add comments for complex logic.
194+
* Ensure samples are complete and runnable.
194195

195196
### Scope Boundaries
196197
**DO:**
197-
* Focus on documentation clarity and accuracy
198-
* Address missing information
199-
* Fix technical inaccuracies
200-
* Improve code samples
198+
* Focus on documentation clarity and accuracy.
199+
* Address missing information.
200+
* Fix technical inaccuracies.
201+
* Improve code samples.
201202

202203
**DON'T:**
203-
* Attempt to fix product bugs through documentation
204-
* Make architectural recommendations
205-
* Add opinions or preferences
206-
* Modify unrelated sections
204+
* Attempt to fix product bugs through documentation.
205+
* Make architectural recommendations.
206+
* Add opinions or preferences.
207+
* Modify unrelated sections.
207208

208209
## Issue labels
209210
* Upon completion of the report, set the `ai-reviewed-issue-reported-action-plan` label for the issue.
@@ -216,17 +217,3 @@ Only recommend using special blocks when truly appropriate, they should not be o
216217
5. **Missing prerequisites**: Add setup steps
217218

218219
---
219-
220-
## Quick Decision Tree
221-
222-
```
223-
Is this a documentation issue?
224-
├── NO → Redirect to product repo
225-
└── YES → Is the information accurate?
226-
├── NO → Provide correction
227-
└── YES → Is it clear enough?
228-
├── NO → Clarify/expand
229-
└── YES → Is it complete?
230-
├── NO → Add missing info
231-
└── YES → Consider if enhancement improves value
232-
```

0 commit comments

Comments
 (0)