Skip to content

[workflow-style] Normalize report formatting for non-compliant workflows #27116

@github-actions

Description

@github-actions

Workflows to Update

The following workflow generates reports (comments) but doesn't fully follow the project's markdown style guidelines:

Workflow File Issues Found
.github/workflows/cloclo.md Example Response Format uses ## (h2) header; missing shared/reporting.md import

Required Changes

.github/workflows/cloclo.md

1. Fix h2 header in Example Response Format

The current example template uses a non-compliant h2 header:

## ✨ Claude Response via `/cloclo`

Should be h3 or lower:

### ✨ Claude Response via `/cloclo`

2. Add shared/reporting.md import

Add to the imports section in the frontmatter:

imports:
  - shared/jqschema.md
  - shared/mcp/serena-go.md
  - shared/reporting.md   # ← add this

This gives the agent explicit guidance on:

  • Using h3 (###) or lower for all headers
  • Wrapping long sections in <details> tags
  • Consistent report structure patterns

Style Guidelines Reference

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy."

2. Progressive Disclosure

Add instruction: "Wrap long sections in <details><summary>Section Name</summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary>Full Analysis Details</summary>

[Long detailed content here...]

</details>

3. Report Structure

Preferred structure:

  • Brief summary (always visible)
  • Key metrics or highlights (always visible)
  • Detailed analysis (in <details> tags)
  • Recommendations (always visible)

Design Principles (Airbnb-Inspired)

The updated workflows should create reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, comparisons
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-observability-report or design-decision-gate that already import shared/reporting.md for good examples of structured reporting.

Agent Task

Update .github/workflows/cloclo.md:

  1. Change ## ✨ Claude Response via to ### ✨ Claude Response via in the Example Response Format
  2. Add - shared/reporting.md to the imports list in the frontmatter
  3. Run make recompile to regenerate the lock file
  4. Verify with make agent-finish

Generated by Workflow Style Normalizer • Run §24616643136

Generated by Workflow Normalizer · ● 2M ·

  • expires on Apr 19, 2026, 11:59 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions