Skip to content

[workflow-style] Normalize report formatting for cli-consistency-checker #16830

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/cli-consistency-checker.md
Issue: This workflow generates issue reports but uses ## (h2) headers in its issue template, and doesn't leverage <details> tags for progressive disclosure.

Required Changes

Update the workflow prompt's issue format template to comply with markdown style guidelines.

1. Header Levels

The current issue format template contains h2 headers such as:

  • ## Summary
  • ## Breakdown by Severity
  • ## Issue Categories
  • ## Inspection Details
  • ## Findings Summary
  • ## Detailed Findings

All of these should be downgraded to h3 (###) or lower, since the issue title acts as h1.

Before:

## Summary

Automated CLI consistency inspection found **X inconsistencies**...

## Breakdown by Severity

After:

### Summary

Automated CLI consistency inspection found **X inconsistencies**...

### Breakdown by Severity

2. Progressive Disclosure

Add <details> tags to wrap the verbose "Detailed Findings" section, so the summary remains visible while full details can be expanded:

<details>
<summary><b>Detailed Findings</b></summary>

#### 1. [Issue Title]
...

</details>

3. Report Structure

Suggest this updated structure for the issue body:

  • Brief summary (always visible) — count and severity breakdown
  • Key categories (always visible) — grouped issue types
  • Detailed findings (in <details> tags) — per-finding breakdown with CLI output quotes
  • Recommendations (always visible) — next steps

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

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

Example Reference

See daily-file-diet.md or ci-coach.md for good examples of structured reporting with proper header levels and <details> usage.

Agent Task

Update .github/workflows/cli-consistency-checker.md to replace all ## headers in the issue format template with ### (or lower), and wrap the "Detailed Findings" section in a <details><summary><b>Detailed Findings</b></summary> block. Run make recompile after making changes.

Generated by Workflow Normalizer

  • expires on Feb 20, 2026, 1:54 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    cookieIssue Monster Loves Cookies!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions