|
| 1 | +--- |
| 2 | +# Reporting Shared Component |
| 3 | +# Provides common issue-reporting conventions for agentic workflows. |
| 4 | +# |
| 5 | +# Usage: |
| 6 | +# imports: |
| 7 | +# - shared/reporting.md |
| 8 | +# |
| 9 | +# This import provides: |
| 10 | +# - Standard formatting guidelines for issues and discussions |
| 11 | +# - Common markdown templates for tables, summaries, and recommendations |
| 12 | + |
| 13 | +safe-outputs: |
| 14 | + create-issue: |
| 15 | + close-older-issues: true |
| 16 | + expires: 7d |
| 17 | +--- |
| 18 | + |
| 19 | +# Reporting Guidelines |
| 20 | + |
| 21 | +Use the following conventions when generating issues, discussions, or step summaries. |
| 22 | + |
| 23 | +## Issue Structure |
| 24 | + |
| 25 | +Every generated issue should include: |
| 26 | + |
| 27 | +1. **Executive Summary** — two-to-three sentence overview of findings. |
| 28 | +2. **Data Table** — key metrics in a compact markdown table. |
| 29 | +3. **Recommendations** — ranked list with estimated impact and concrete action. |
| 30 | +4. **Caveats** — sampling limits, missing data, or edge cases that affect confidence. |
| 31 | + |
| 32 | +Use `<details>` blocks for long supporting tables to keep the top-level view concise. |
| 33 | + |
| 34 | +## Markdown Conventions |
| 35 | + |
| 36 | +- Use `**bold**` for metric names and important values. |
| 37 | +- Format large numbers with commas (e.g., `1,234,567`). |
| 38 | +- Format costs as `$X.XX` (two decimal places). |
| 39 | +- Use emoji sparingly: ✅ success, ⚠️ warning, ❌ failure, 📊 data, 💡 insight. |
| 40 | +- Link to relevant runs, PRs, or issues where possible. |
| 41 | + |
| 42 | +## Table Template |
| 43 | + |
| 44 | +```markdown |
| 45 | +| Metric | Value | Notes | |
| 46 | +|---|---|---| |
| 47 | +| Total runs | N | Last N days | |
| 48 | +| Total tokens | N | Formatted with commas | |
| 49 | +| Total cost | $X.XX | USD | |
| 50 | +| Avg tokens/run | N | | |
| 51 | +``` |
| 52 | + |
| 53 | +## Recommendations Template |
| 54 | + |
| 55 | +```markdown |
| 56 | +### Recommendations |
| 57 | + |
| 58 | +1. **[Title]** — estimated savings: ~N tokens/run |
| 59 | + - **Action**: ... |
| 60 | + - **Evidence**: ... |
| 61 | + |
| 62 | +2. **[Title]** — estimated savings: ~N tokens/run |
| 63 | + - **Action**: ... |
| 64 | + - **Evidence**: ... |
| 65 | +``` |
0 commit comments