David Karlsson
8571e1b322
The lint script was buried in the write skill's scripts directory, so only agents that invoked that specific skill discovered it. Move it to the repo-level scripts/ directory and reference it from AGENTS.md so every agent session sees the recommended workflow. - scripts/lint.sh: scoped markdownlint + vale on changed files - AGENTS.md Commands and Verification loop now point here - write skill SKILL.md updated to use the new path - post-edit.sh stays in the skill (it's a PostToolUse hook tied to that skill's lifecycle) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2.5 KiB
name, description, hooks
| name | description | hooks | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| write | Write a documentation fix on a branch. Makes the minimal change, formats, self-reviews, and commits. Use after research has identified what to change. "write the fix", "make the changes", "implement the fix for #1234". |
|
Write
Make the minimal change that resolves the issue. Research has already identified what to change — this skill handles the edit, formatting, self-review, and commit.
1. Create a branch
git checkout -b fix/issue-<number>-<short-desc> main
Use a short kebab-case description derived from the issue title (3-5 words).
2. Read then edit
Always read each file before modifying it. Make the minimal change that fixes the issue. Do not improve surrounding content, add comments, or address adjacent problems.
Follow the writing guidelines in CLAUDE.md, STYLE.md, and COMPONENTS.md.
3. Front matter check
Every content page requires title, description, and keywords in its
front matter. If any are missing from a file you touch, add them.
4. Validate
Prettier runs automatically after each edit via the PostToolUse hook. Run lint manually after all edits are complete:
scripts/lint.sh <changed-files>
The lint script runs markdownlint and vale on only the files you pass it, so the output is scoped to your changes. Fix any errors it reports.
5. Self-review
Re-read each changed file: right file, right lines, change is complete,
front matter is present. Run git diff and verify only intended changes
are present.
6. Commit
Stage only the changed files:
git add <files>
git diff --cached --name-only # verify — no package-lock.json or other noise
git commit -m "$(cat <<'EOF'
docs: <short description under 72 chars> (fixes #NNNN)
<What was wrong: one sentence citing the specific problem.>
<What was changed: one sentence describing the exact edit.>
Co-Authored-By: Claude <noreply@anthropic.com>
EOF
)"
The commit body is mandatory. A reviewer reading only the commit should understand the problem and the fix without opening the issue.
Notes
- Never edit
_vendor/ordata/cli/— these are vendored - If a file doesn't exist, check for renames:
git log --all --full-history -- "**/filename.md" - If the fix requires a URL that cannot be verified, stop and report a blocker rather than guessing