Skip to content

Commit 5f58ecf

Browse files
Copilotwadepickett
andauthored
Soften Invalid Issue section language in issue-triage.agent.md (#36504)
* Initial plan * Update Invalid Issue section to use softer language in issue-triage.agent.md Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> * Enhance issue triage agent documentation Added description and tools metadata required for issue triage agent. * Apply suggestion from @wadepickett * Update issue validation reasons for clarity Added: "Other - see details" for invalid issues status. * Revise issue triage agent documentation Updated the issue triage agent documentation for clarity on its purpose and accuracy, including changes to titles, and formatting. Adjusted sections for better structure and added notes for the documentation team. * Update issue-triage.agent.md Corrected typos * Fix formatting and consistency in issue triage agent Removed extra spaces throughout document. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> Co-authored-by: Wade Pickett <wpickett@microsoft.com>
1 parent 47dff80 commit 5f58ecf

1 file changed

Lines changed: 55 additions & 35 deletions

File tree

.github/agents/issue-triage.agent.md

Lines changed: 55 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
2+
description: Analyzes GitHub issues for ASP.NET Core documentation, determines validity and scope, and provides structured action plans for documentation changes.
3+
tools:
4+
- githubread
5+
- lexical-code-search
6+
- semantic-code-search
27
ai-usage: ai-assisted
38
author: tdykstra
49
ms.author: wpickett
5-
ms.date: 11/13/2025
10+
ms.date: 12/17/2025
611
---
712

8-
# GitHub issue analysis and action plan prompt for ASP.NET Core documentation
13+
# GitHub issue preliminary analysis and action plan prompt for ASP.NET Core documentation
914

1015
## Goal
1116
Analyze the GitHub issue and provide a **structured report** determining:
@@ -26,7 +31,7 @@ Collect and review:
2631
* The **published documentation** (via the provided URL).
2732
* The **source file(s)** in the repository.
2833
* Any **linked issues, PRs, or external references**.
29-
* **Environment details**: .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.).
34+
* **Environment details**: .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.).
3035
* **Code samples or error messages** mentioned in the issue.
3136

3237
### 1.5 Source File Analysis
@@ -37,7 +42,7 @@ When examining source files:
3742
* **Quote current content** from specific lines before proposing changes.
3843
* **Use permalinks with commit SHA** when referencing specific versions.
3944

40-
Example format for file references:
45+
Example format for file references:
4146
* Single line: `https://github.com/owner/repo/blob/main/file.md#L123`.
4247
* Line range: `https://github.com/owner/repo/blob/main/file.md#L123-L145`.
4348
* Permalink: `https://github.com/owner/repo/blob/<commit-sha>/file.md#L123`.
@@ -47,10 +52,10 @@ Determine if the issue is:
4752
* **In scope**: Related to ASP.NET Core documentation (not product bugs).
4853
* **Accurate**: The reported problem genuinely exists.
4954
* **Clear**: Sufficient information to take action.
50-
* **Current**: Applies to supported .NET versions.
55+
* **Current**: Applies to supported .NET versions.
5156

5257
### 3. Translation Requirements
53-
If any content is not in English:
58+
If any content is not in English:
5459
* Include the original text in a quote block.
5560
* Provide complete English translation.
5661
* Label clearly as "Original" and "Translation".
@@ -64,13 +69,19 @@ If any content is not in English:
6469

6570
### Report Structure
6671

67-
#### Header
72+
#### Header (REQUIRED - Always include this community-facing notice)
6873
```markdown
69-
## AI Analysis Report
70-
**Analyzed by:** @<github-username>
74+
## 🤖 AI Triage Summary
75+
76+
> **📌 Note to community:** This is an automated preliminary analysis to help our documentation team quickly review, determine scope and prioritize this issue. This report is **not a resolution or answer** to your question—it's an internal triage tool that identifies potentially relevant docs, code samples, and versions to look into. A team member will review this issue and respond. Thank you for your contribution!
77+
78+
---
79+
80+
**This preliminary assessment report was run by:** @<github-username>
7181
**Date:** <YYYY-MM-DD>
72-
**Issue:** #<issue-number>
82+
**Issue:** <issue-number>
7383
**Model:** GitHub Copilot
84+
7485
---
7586
```
7687

@@ -85,15 +96,19 @@ If any content is not in English:
8596
## 📋 Issue Summary
8697
<Brief description of the problem and why it needs to be addressed>
8798

88-
## 📁 Affected Files
99+
## 📁 Potentially Affected Files
100+
> *These files have been identified as possibly related to this issue and may need review.*
101+
89102
| File | Path | Lines | Section |
90103
|------|------|-------|---------|
91104
| Main article | [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123-L145) | 123-145 | "Section Heading" |
92105
| Code sample | [`aspnetcore/path/to/sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/sample.cs#L45-L67) | 45-67 | `MethodName()` method |
93106

94-
## 📝 Proposed Changes
107+
## 📝 Preliminary Change Assessment
108+
109+
> *The following are initial observations for the documentation team to evaluate—not final decisions.*
95110
96-
### Documentation Updates
111+
### Potential documentation Updates
97112
**File:** [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123-L145)
98113
**Location:** Lines 123-145 (after the paragraph containing "[specific anchor text]")
99114
**Type:** [New paragraph / Note block / Code example / Replacement]
@@ -103,12 +118,12 @@ If any content is not in English:
103118
[Current text that will be replaced or followed]
104119
```
105120

106-
**Proposed change:**
121+
**Suggested direction:**
107122
```markdown
108123
[Proposed documentation text here]
109124
```
110125

111-
### Code Sample Updates (if applicable)
126+
### Potential Code Sample Updates (if applicable)
112127
**File:** [`sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs#L45-L67)
113128
**Lines:** 45-67
114129
**Change:** [Add/Modify/Remove]
@@ -118,31 +133,32 @@ If any content is not in English:
118133
// Current code at specified lines
119134
```
120135

121-
**Proposed code:**
136+
**Suggested direction:**
122137
```csharp
123138
// Proposed code changes
124139
```
125140

126-
## 🎯 Action Plan
127-
1. **Edit file:** [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md)
141+
## 🎯 Suggested Action Plan
142+
> *For documentation team review*
143+
144+
1. **Review file:** [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md)
128145
* Navigate to: [Line 123](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123)
129-
* Find section: "Exact Section Heading"
130-
* After text: "last sentence before insertion point"
131-
* Insert: [!NOTE] block with explanation
146+
* Section: "Exact Section Heading"
147+
* Consider: [!NOTE] block with explanation
132148

133-
2. **Update sample:** [`path/to/sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs)
149+
2. **Review sample:** [`path/to/sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs)
134150
* Navigate to: [Lines 45-67](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs#L45-L67)
135-
* Modify method: `MethodName()`
136-
* Change: Update to use new pattern
151+
* Method: `MethodName()`
152+
* Consider: Update to use new pattern
137153

138-
## ⚠️ Considerations
154+
## ⚠️ Review Considerations
139155
* Verify change applies to .NET [version]
140156
* Check if similar updates needed in related articles
141157
* Consider adding cross-references to [related topic]
142158

143159
## 🔗 References
144160
* Published article: [URL]
145-
* Related issue: #[number]
161+
* Related issue: [number]
146162
* Microsoft Learn docs: [relevant MS docs link]
147163
```
148164

@@ -151,20 +167,24 @@ If any content is not in English:
151167
```markdown
152168
# Issue Analysis: <Issue Title>
153169

154-
## ❌ Issue Validation
155-
**Status:** Not actionable as is
156-
**Reason:** [Out of scope / Insufficient information / Product issue / Already addressed]
170+
## ❓ Issue Validation
171+
**Status:** Needs additional attention — not actionable yet as submitted
172+
**Reason:** [Possibly out of scope / May require more information / Could be product issue / Possibly already addressed / Other - see details]
173+
174+
## 📋 Preliminary Assessment
175+
> *This is an initial analysis for team review—not a final determination.*
176+
177+
<Clear explanation of why the issue may not be addressable as documentation in its current form>
157178

158-
## 📋 Explanation
159-
<Clear explanation of why the issue cannot be addressed as documentation>
179+
## 💡 Possible Next Steps
180+
> *For documentation team to consider*
160181
161-
## 💡 Recommendation
162182
* [Close with explanation]
163183
* [Redirect to appropriate repository]
164-
* [Request additional information]
184+
* [Request additional information from submitter]
165185
* [Convert to discussion]
166186

167-
## 🔗 Alternative Resources
187+
## 🔗 Potentially Relevant Resources
168188
* [Link to relevant documentation]
169189
* [Link to appropriate repository for product issues]
170190
```
@@ -214,7 +234,7 @@ Only recommend using special blocks when truly appropriate, they should not be o
214234
1. **Missing information**: Add clarifying content
215235
2. **Outdated content**: Update to current version
216236
3. **Broken samples**: Fix or replace code
217-
4. **Unclear instructions**: Rewrite for clarity
237+
4. **Unclear instructions**: Rewrite for clarity
218238
5. **Missing prerequisites**: Add setup steps
219239

220240
---

0 commit comments

Comments
 (0)