diff --git a/.github/workflows/daily-otel-instrumentation-advisor.md b/.github/workflows/daily-otel-instrumentation-advisor.md index c86b1098abb..2200561fe4c 100644 --- a/.github/workflows/daily-otel-instrumentation-advisor.md +++ b/.github/workflows/daily-otel-instrumentation-advisor.md @@ -251,6 +251,10 @@ If you found a Sentry issue related to this problem, include the issue URL.> *Generated by the [Daily OTel Instrumentation Advisor](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) workflow* ``` +## Report Formatting Guidelines + +Use h3 (`###`) or lower for all headers in your report. Never use h1 (`#`) or h2 (`##`) — these are reserved for the issue title. Wrap long sections in `
Section Name` tags to improve readability. + ## Output Requirements You **MUST** call exactly one of these safe-output tools before finishing: diff --git a/.github/workflows/daily-safe-outputs-conformance.md b/.github/workflows/daily-safe-outputs-conformance.md index 60ecf7e5a2a..0ea9ca00af7 100644 --- a/.github/workflows/daily-safe-outputs-conformance.md +++ b/.github/workflows/daily-safe-outputs-conformance.md @@ -121,7 +121,7 @@ Example: `SEC-001: Agent job in workflow X has write permissions` - **Handlers**: [List handler files if applicable]
-🔍 Current vs Expected Behavior +🔍 Current vs Expected Behavior ### Current Behavior @@ -180,7 +180,7 @@ 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. +- **Report Formatting**: Use h3 (`###`) or lower for all headers in your report. Never use h1 (`#`) or h2 (`##`) — these are reserved for the issue title. Wrap long sections in `
Section Name` tags to improve readability. After processing all issues, provide a summary in the workflow output: diff --git a/.github/workflows/daily-secrets-analysis.md b/.github/workflows/daily-secrets-analysis.md index 5af532abd77..c8382e2ce00 100644 --- a/.github/workflows/daily-secrets-analysis.md +++ b/.github/workflows/daily-secrets-analysis.md @@ -292,7 +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. +- **Report Formatting**: Use h3 (`###`) or lower for all headers in your report. Never use h1 (`#`) or h2 (`##`) — these are reserved for the issue title. Wrap long sections in `
Section Name` tags to improve readability. - Focus on **trends and changes** rather than static inventory - Highlight **security concerns** prominently - Keep the report **concise but comprehensive** diff --git a/.github/workflows/daily-skill-optimizer.md b/.github/workflows/daily-skill-optimizer.md index 73cfc49abde..ca58ccdc7d3 100644 --- a/.github/workflows/daily-skill-optimizer.md +++ b/.github/workflows/daily-skill-optimizer.md @@ -179,4 +179,40 @@ The separate `skill_optimizer` job already ran `fastxyz/skill-optimizer` and pac - Expected impact for each improvement - Keep recommendations specific to this repository and immediately actionable. +## Issue Format Guidelines + +Use h3 (`###`) or lower for all headers in your report. Never use h1 (`#`) or h2 (`##`) — these are reserved for the issue title. + +Wrap long sections in `
Section Name` tags to improve readability. Example: + +```markdown +
+Full Analysis Details + +[Long detailed content here...] + +
+``` + +Structure the issue body as follows: + +```markdown +### Summary +- Run mode: dry-run / benchmark +- Status: ✅/⚠️/❌ + +### Key Findings +[Always visible — the 3 improvements with expected impact] + +
+Evidence from Artifact + +[Concrete references to artifact files and log excerpts] + +
+ +### Recommendations +[Numbered list of 3 actionable improvements] +``` + Do not call `noop` for this workflow; always create exactly one issue with exactly 3 improvements. diff --git a/.github/workflows/spec-librarian.md b/.github/workflows/spec-librarian.md index 0c6c829e621..cbb0a88d1eb 100644 --- a/.github/workflows/spec-librarian.md +++ b/.github/workflows/spec-librarian.md @@ -267,7 +267,7 @@ The following packages have no README.md: The following specifications are outdated:
-View stale specifications (N packages) +View stale specifications (N packages) #### `parser` — Stale by 42 days @@ -284,7 +284,7 @@ The following specifications are outdated: ### 🔄 Cross-Package Inconsistencies
-View inconsistencies (N issues) +View inconsistencies (N issues) #### Terminology Conflict @@ -328,7 +328,7 @@ The following specifications are outdated: 1. **Be thorough**: Check ALL packages, not just a sample 2. **Be precise**: Reference exact file paths, function names, and dates 3. **Be actionable**: Every finding should have a clear recommendation -4. **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. +4. **Report Formatting**: Use h3 (`###`) or lower for all headers in your report. Never use h1 (`#`) or h2 (`##`) — these are reserved for the issue title. Wrap long sections in `
Section Name` tags to improve readability. 5. **Use progressive disclosure**: Wrap details in `
` tags 6. **One issue per run**: The `max: 1` limit ensures no issue spam 7. **Skip if open**: The `skip-if-match` rule prevents duplicate issues