Skip to content

[workflow-style] Normalize report formatting for duplicate-code-detector #13642

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/duplicate-code-detector.md
Issue: This workflow detects code duplication and creates reports, but doesn't include markdown style guidelines.

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

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

Example:

### Code Duplication Analysis
#### High-Priority Duplicates

2. Progressive Disclosure

Add instruction: "Wrap detailed code snippets and file comparisons in <details><summary><b>Section Name</b></summary> tags to improve readability."

Example:

<details>
<summary><b>Full Duplicate Code Blocks</b></summary>

[Complete duplicate code snippets and locations...]

</details>

3. Report Structure

Suggest a structure like:

  • Summary (always visible): Duplication percentage, number of instances
  • Critical Duplicates (always visible): Large or complex duplicate blocks
  • Detailed Analysis (in <details> tags): All duplicates with code snippets, file locations
  • Refactoring Recommendations (always visible): Suggested consolidation approaches

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Duplication metrics immediately visible
  2. Exceed expectations: Add helpful context like impact on maintainability, refactoring patterns
  3. Create delight: Use progressive disclosure to hide verbose code blocks
  4. Maintain consistency: Follow the same patterns as other code analysis workflows

Example Reference

See workflows like audit-workflows that import shared/reporting.md for good examples of structured reporting.

Agent Task

  1. Update .github/workflows/duplicate-code-detector.md to include an import: - shared/reporting.md in the frontmatter imports section
  2. Reference the style guidelines in the workflow instructions
  3. Test the updated workflow to ensure it produces well-formatted duplication reports

AI generated by Workflow Normalizer

  • expires on Feb 11, 2026, 3:23 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions