Skip to content

Add Checkstyle Recipe Coverage Table to READMEΒ #21

@rdiachenko

Description

@rdiachenko

Add a table to the README that documents the coverage status of OpenRewrite recipes for all Checkstyle checks. This will help contributors understand what's been implemented, and what's not feasible for auto-fixing.

The table should be organized by Checkstyle's category structure (Coding, Annotations, Block Checks, etc.) with the following columns:

Status Check Recipe Coverage Notes

Example

Status Legend

🟒 Full Coverage - Complete auto-fix capability for all violation scenarios
🟑 Partial Coverage - Auto-fix available for some but not all violation scenarios
πŸ”΄ Won't Be Covered - Auto-fix not feasible or not planned

Coding

Status Check Recipe Coverage Notes
🟒 UpperEll UpperEll
🟒 FinalLocalVariable TBD
🟑 MagicNumber TBD Only fixes simple cases - extracts obvious constants; complex expressions require manual review

Annotations

No checks analyzed yet

Block Checks

No checks analyzed yet

...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions