| ai-usage | ai-assisted |
|---|---|
| author | TylerMSFT |
| ms.author | twhitney |
| ms.date | 11/13/2025 |
Analyze the GitHub issue and provide a structured report determining:
- Whether the issue is valid and actionable.
- Whether the issue is within scope of the articles the issue relates to, or if a new article is needed.
- The exact documentation changes required (if applicable).
- A clear action plan that can guide PR creation.
The report should be suitable for posting directly in the issue discussion.
Collect and review:
- The issue title, description, and all comments.
- The published documentation (via the provided URL).
- The source file(s) in the repository.
- Any linked issues, PRs, or external references.
- Environment details: .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.).
- Code samples or error messages mentioned in the issue.
When examining source files:
- Provide direct GitHub permalinks to specific lines or sections.
- Note exact line numbers for proposed changes.
- Include line number ranges in GitHub URLs using
#L<start>-L<end>format. - Quote current content from specific lines before proposing changes.
- Use permalinks with commit SHA when referencing specific versions.
Example format for file references:
- Single line:
https://github.com/owner/repo/blob/main/file.md#L123. - Line range:
https://github.com/owner/repo/blob/main/file.md#L123-L145. - Permalink:
https://github.com/owner/repo/blob/<commit-sha>/file.md#L123.
Determine if the issue is:
- In scope: Related to ASP.NET Core documentation (not product bugs).
- Accurate: The reported problem genuinely exists.
- Clear: Sufficient information to take action.
- Current: Applies to supported .NET versions.
If any content is not in English:
- Include the original text in a quote block.
- Provide complete English translation.
- Label clearly as "Original" and "Translation".
<issue-number>-analysis-report.md
## AI Analysis Report
**Analyzed by:** @<github-username>
**Date:** <YYYY-MM-DD>
**Issue:** #<issue-number>
**Model:** GitHub Copilot
---# Issue Analysis: <Concise Issue Title>
## ✅ Issue Validation
**Status:** Valid and actionable
## 📋 Issue Summary
<Brief description of the problem and why it needs to be addressed>
## 📁 Affected Files
| File | Path | Lines | Section |
|------|------|-------|---------|
| 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" |
| 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 |
## 📝 Proposed Changes
### Documentation Updates
**File:** [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123-L145)
**Location:** Lines 123-145 (after the paragraph containing "[specific anchor text]")
**Type:** [New paragraph / Note block / Code example / Replacement]
**Current content (lines 123-125):**
```markdown
[Current text that will be replaced or followed]Proposed change:
[Proposed documentation text here]File: sample.cs
Lines: 45-67
Change: [Add/Modify/Remove]
Current code:
// Current code at specified linesProposed code:
// Proposed code changes-
Edit file:
aspnetcore/path/to/file.md- Navigate to: Line 123
- Find section: "Exact Section Heading"
- After text: "last sentence before insertion point"
- Insert: [!NOTE] block with explanation
-
Update sample:
path/to/sample.cs- Navigate to: Lines 45-67
- Modify method:
MethodName() - Change: Update to use new pattern
- Verify change applies to .NET [version]
- Check if similar updates needed in related articles
- Consider adding cross-references to [related topic]
- Published article: [URL]
- Related issue: #[number]
- Microsoft Learn docs: [relevant MS docs link]
#### For Invalid Issues
```markdown
# Issue Analysis: <Issue Title>
## ❌ Issue Validation
**Status:** Not actionable as is
**Reason:** [Out of scope / Insufficient information / Product issue / Already addressed]
## 📋 Explanation
<Clear explanation of why the issue cannot be addressed as documentation>
## 💡 Recommendation
* [Close with explanation]
* [Redirect to appropriate repository]
* [Request additional information]
* [Convert to discussion]
## 🔗 Alternative Resources
* [Link to relevant documentation]
* [Link to appropriate repository for product issues]
- Always inspect the actual source file to determine accurate line numbers.
- Provide line ranges rather than single lines when changes affect multiple lines.
- Use GitHub's line highlighting format in URLs (#L123 for single, #L123-L145 for range).
- Quote the existing content at those lines to confirm accuracy.
- Consider context lines - include a few lines before/after for clarity.
- Update line numbers if the file has changed since issue creation.
Only recommend using special blocks when truly appropriate, they should not be overused:
[!IMPORTANT]: Security issues, breaking changes, data loss risks[!WARNING]: Common mistakes, deprecation notices[!NOTE]: Helpful clarifications, version-specific info[!TIP]: Best practices, productivity hints
- Use appropriate language identifier for syntax highlighting.
- Include necessary
usingstatements or imports. - Add comments for complex logic.
- Ensure samples are complete and runnable.
DO:
- Focus on documentation clarity and accuracy.
- Address missing information.
- Fix technical inaccuracies.
- Improve code samples.
DON'T:
- Attempt to fix product bugs through documentation.
- Make architectural recommendations.
- Add opinions or preferences.
- Modify unrelated sections.
- Upon completion of the report, set the
ai-reviewed-issue-reported-action-planlabel for the issue.
- Missing information: Add clarifying content
- Outdated content: Update to current version
- Broken samples: Fix or replace code
- Unclear instructions: Rewrite for clarity
- Missing prerequisites: Add setup steps