Files
computer-playbook/docs/agents/action/refactor.md
T
kevinveenbirkenbachandClaude Opus 4.7 16bdbf03d7 docs: fix repo-wide drift against documentation.md style rules
Three classes of drift cleaned up across 85 .md files:

- Em-dashes: replaced ` — ` with the contextually correct separator
  (colon for `term: explanation`, period to split clauses across
  sentences/source lines, parentheses for asides, semicolon for
  tight-linked continuations). Two intentional exceptions remain
  in `docs/contributing/documentation.md` (the rule literal) and
  inside a fenced ```sh block in `docs/contributing/actions/debugging/ci.md`.
- SPOT self-labels: rewrote "This is the SPOT for X" to describe
  the subject directly ("This directory holds X" / "This file
  describes X"). Cross-references to other artefacts' canonical
  role remain unchanged.
- Heading-emoji position: moved leading-emoji headings (`# 🧩 Title`)
  to trailing position (`# Title 🧩`) per the headline rule that
  emojis MUST come after the title text.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 20:12:07 +02:00

1.2 KiB

Refactoring and Optimization

After Every Commit

After every commit you MUST ask the user:

"Do you want to refactor and optimize the affected files?"

  • If the user answers no, continue without refactoring.
  • If the user answers yes, follow the steps below.

Refactoring Steps

  1. You MUST re-read AGENTS.md and follow all instructions in it before proceeding.
  2. You MUST apply all rules from AGENTS.md and docs/contributing/ to every affected file, not only code rules, but also documentation, naming, structure, and any other applicable guidelines.
  3. For every affected documentation file, you MUST optimize the text so it follows the standards defined in documentation.md, including RFC 2119 keywords, link formatting, and writing style.
  4. If the change affects an Ansible role, you MUST refactor and optimize the entire role, not only the files that were directly modified.
    • If the change affects more than one role, you MUST ask the user before proceeding:

      "The following roles are affected: [list]. Which roles should be refactored, specific ones or all?"

    • Then refactor only the roles confirmed by the user.