diff --git a/.github/workflows/daily-code-metrics.md b/.github/workflows/daily-code-metrics.md index 69f1f00f10b..70e97cac6e7 100644 --- a/.github/workflows/daily-code-metrics.md +++ b/.github/workflows/daily-code-metrics.md @@ -406,6 +406,7 @@ Brief 2-3 paragraph executive summary highlighting key findings, quality score, ### Report Guidelines +- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `
Section Name` tags to improve readability and reduce scrolling. - Include all 6 visualization charts as embedded images - Upload charts using `upload asset` tool for permanent URLs - Provide brief analysis for each chart diff --git a/.github/workflows/daily-compiler-quality.md b/.github/workflows/daily-compiler-quality.md index 5ef3a3ce1fc..e6be9efb5a5 100644 --- a/.github/workflows/daily-compiler-quality.md +++ b/.github/workflows/daily-compiler-quality.md @@ -561,6 +561,8 @@ The compiler codebase maintains **good overall quality** with an average score o ## Important Guidelines +- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `
Section Name` tags to improve readability and reduce scrolling. + ### Analysis Best Practices - **Be Objective**: Use concrete metrics from Serena, not subjective opinions diff --git a/.github/workflows/daily-observability-report.md b/.github/workflows/daily-observability-report.md index b1fad0d1e13..4f5597d892e 100644 --- a/.github/workflows/daily-observability-report.md +++ b/.github/workflows/daily-observability-report.md @@ -369,6 +369,7 @@ Follow the formatting guidelines above. Use the following structure: ### Report Quality +- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `
Section Name` tags to improve readability and reduce scrolling. - Be specific with numbers and percentages - Link to actual workflow runs for context - Provide actionable recommendations diff --git a/.github/workflows/daily-performance-summary.md b/.github/workflows/daily-performance-summary.md index 8386f85cd00..11e3769fc82 100644 --- a/.github/workflows/daily-performance-summary.md +++ b/.github/workflows/daily-performance-summary.md @@ -389,6 +389,8 @@ Create a new discussion with the comprehensive performance report. ### Discussion Format +- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `
Section Name` tags to improve readability and reduce scrolling. + **Title**: `[daily performance] Daily Performance Summary - YYYY-MM-DD` **Body**: diff --git a/.github/workflows/daily-safe-outputs-conformance.md b/.github/workflows/daily-safe-outputs-conformance.md index b6b89917521..cba5de4795f 100644 --- a/.github/workflows/daily-safe-outputs-conformance.md +++ b/.github/workflows/daily-safe-outputs-conformance.md @@ -177,6 +177,8 @@ If multiple similar issues are found (e.g., 3 handlers missing the same validati ## Phase 4: Summary Report +- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `
Section Name` tags to improve readability and reduce scrolling. + After processing all issues, provide a summary in the workflow output: ```markdown diff --git a/.github/workflows/daily-secrets-analysis.md b/.github/workflows/daily-secrets-analysis.md index 964d57b0ba9..cfda5c6619f 100644 --- a/.github/workflows/daily-secrets-analysis.md +++ b/.github/workflows/daily-secrets-analysis.md @@ -292,6 +292,7 @@ For detailed information about secret usage patterns, see: ## Notes +- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `
Section Name` tags to improve readability and reduce scrolling. - Focus on **trends and changes** rather than static inventory - Highlight **security concerns** prominently - Keep the report **concise but comprehensive**