Well Formed

Review pull request diffs for code smells, style issues, and safety problems before merging.

luongnv89 e904b02 1.0 KB Updated

File contents

Well-formed corpus skill

When to Use

  • When the user asks to "review this PR" or "check the diff"
  • Before merging any change larger than 10 lines

Prerequisites

  • A git repository with the target branch checked out
  • Read access to the files being reviewed

Instructions

  1. Run git diff main...HEAD to list files
  2. Read each file and check for common smells
  3. Emit a markdown report summarising findings

Example

$ asm eval ./well-formed
Overall score: 95/100

Acceptance Criteria

  • Produces a markdown report with sections per file
  • Flags any use of eval() or exec as dangerous
  • Does not modify the working tree

Edge cases

  • Empty diffs: emit a short "no changes" note
  • Binary files: skip and mention the filename in the report

Safety

See references/safety.md for error handling rules. Always confirm before writing. Never run destructive commands without a dry-run.

luongnv89/asm/tree/main/tests/fixtures/skills/well-formed commit e904b02b02

Frequently asked questions

npx skillmds@latest add luongnv89/well-formed