diff --git a/.github/workflows/cli-consistency-checker.md b/.github/workflows/cli-consistency-checker.md index 93c09f97fe..6659d16ee0 100644 --- a/.github/workflows/cli-consistency-checker.md +++ b/.github/workflows/cli-consistency-checker.md @@ -158,33 +158,35 @@ When issues are found, create a **single consolidated issue** that includes: - Suggested fix if applicable - Priority level: `high` (breaks functionality), `medium` (confusing/misleading), `low` (minor inconsistency) +**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>5 findings) in `
Section Name` tags to improve readability. The issue title serves as h1, so start section headers at h3. + ### Issue Format ```markdown -## Summary +### Summary Automated CLI consistency inspection found **X inconsistencies** in command help text that should be addressed for better user experience and documentation clarity. -### Breakdown by Severity +#### Breakdown by Severity - **High**: X (Breaks functionality) - **Medium**: X (Inconsistent terminology) - **Low**: X (Minor inconsistencies) -### Issue Categories +#### Issue Categories 1. **[Category Name]** (X commands) - Brief description of the pattern - Affects: `command1`, `command2`, etc. -### Inspection Details +#### Inspection Details - **Total Commands Inspected**: XX - **Commands with Issues**: X - **Date**: [Date] - **Method**: Executed all CLI commands with `--help` flags and analyzed actual output -### Findings Summary +#### Findings Summary ✅ **No issues found** in these areas: - [List areas that passed inspection] @@ -192,7 +194,8 @@ Automated CLI consistency inspection found **X inconsistencies** in command help ⚠️ **Issues found**: - [List areas with issues] -### Detailed Findings +
+Detailed Findings #### 1. [Issue Title] @@ -213,6 +216,8 @@ Automated CLI consistency inspection found **X inconsistencies** in command help [Repeat for each finding] +
+ ``` **Important Notes**: diff --git a/.github/workflows/repository-quality-improver.md b/.github/workflows/repository-quality-improver.md index dd2f3258d9..6a681034c6 100644 --- a/.github/workflows/repository-quality-improver.md +++ b/.github/workflows/repository-quality-improver.md @@ -294,22 +294,24 @@ Create a comprehensive report using the **reporting MCP** with the following str ### Report Template +**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The discussion title serves as h1, so start section headers at h3. + ```markdown -# 🎯 Repository Quality Improvement Report - [FOCUS AREA] +### 🎯 Repository Quality Improvement Report - [FOCUS AREA] **Analysis Date**: [DATE] **Focus Area**: [SELECTED AREA] **Strategy Type**: [Custom/Standard/Reused] **Custom Area**: [Yes/No - If yes, explain the rationale for this specific focus] -## Executive Summary +### Executive Summary [2-3 paragraphs summarizing the analysis findings and key recommendations]
Full Analysis Report -## Focus Area: [AREA NAME] +### Focus Area: [AREA NAME] ### Current State Assessment