-
Notifications
You must be signed in to change notification settings - Fork 54
Closed
Labels
cookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Workflow to Update
Workflow File: .github/workflows/issue-triage-agent.md
Issues Found:
- Comments added to issues don't follow formatting guidelines
- Doesn't import
shared/reporting.mdguidelines - No progressive disclosure instructions
Current Behavior
The workflow adds comments explaining label additions (line 26) but doesn't specify formatting guidelines for comment structure.
Required Changes
1. Import Shared Reporting Guidelines
Add to the imports section at the top of the file:
imports:
- shared/reporting.md2. Update Comment Instructions
Current (line 26):
After adding the label to an issue, mention the issue author in a comment explaining why the label was added.Updated with structured format:
After adding the label to an issue, mention the issue author in a comment using this format (follow shared/reporting.md guidelines):
**Comment Template**:
\`\`\`markdown
### 🏷️ Issue Triaged
Hi @{author}! I've categorized this issue as **{label_name}** based on the following analysis:
**Reasoning**: {brief_explanation_of_why_this_label}
<details>
<summary><b>View Triage Details</b></summary>
#### Analysis
- **Keywords detected**: {list_of_keywords_that_matched}
- **Issue type indicators**: {what_made_this_fit_the_category}
- **Confidence**: {High/Medium/Low}
#### Recommended Next Steps
- {context_specific_suggestion_1}
- {context_specific_suggestion_2}
</details>
**References**: [Triage run §{run_id}](https://github.com/githubnext/gh-aw/actions/runs/{run_id})
\`\`\`
**Key formatting requirements**:
- Use h3 (###) for the main heading
- Keep reasoning visible for quick understanding
- Wrap detailed analysis in `<details>` tags
- Include workflow run reference
- Keep total comment concise (collapsed details prevent noise)3. Add Batch Comment Optimization
If triaging multiple issues in one run, consider a summary comment pattern:
For efficiency, if multiple issues are triaged in a single run:
1. Add individual labels to each issue
2. Add a brief comment to each issue (using the template above)
3. Optionally: Create a discussion summarizing all triage actions for that run
This provides both per-issue context and batch visibility.Design Principles
The updated comments should:
- Build trust through clarity: Clear reasoning immediately visible
- Respectful to maintainers: Concise by default, details available on demand
- Actionable: Include next steps relevant to the label
- Consistent formatting: Matches patterns from other triage workflows
Reference Examples
Good examples of triage comment formatting:
pr-triage-agent.md- Structured triage comments with reasoningshared/reporting.md- Progressive disclosure guidelines
Testing
After making changes:
- Trigger the workflow with
workflow_dispatch - Find an unlabeled issue for the workflow to triage
- Verify the added comment uses h3 headers
- Verify detailed analysis is in
<details>tags - Verify reasoning is immediately visible without expanding
AI generated by Workflow Normalizer
- expires on Feb 2, 2026, 12:26 PM UTC
Reactions are currently unavailable
Metadata
Metadata
Labels
cookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request