Defame1297andClaude Code
d576695bb9
- instructions-author: keep two Gotchas, move the rest to the Step 2 contract and verify.md; add references/content.md on what belongs in an instructions file and tighten the template bullets to match - instructions-author, skill-author, agent-author: remove the commit verification step; committing is out of scope for author skills - skill-author 1.0.6, agent-author 1.0.4 (ADR-0022 patch bumps) Refs #148 Co-Authored-By: Claude Code <[email protected]> Claude-Session: https://claude.ai/code/session_01KkT7RSDwDbmrM9T34b6sTi
1.6 KiB
1.6 KiB
source_keys
| source_keys | |
|---|---|
|
What belongs in an instructions file
Reached from SKILL.md Step 2. Claude reads instructions as context, not as enforced configuration, so a rule only helps if it is specific, short and not contradicted elsewhere.
Write rules an agent can check
| Weak | Checkable |
|---|---|
| Format code properly | Use 2-space indentation |
| Test your changes | Run npm test before committing |
| Keep files organized | API handlers live in src/api/handlers/ |
Group related bullets under a short heading. Give the reason when a rule looks arbitrary; a rule with a stated reason survives the edge case.
Keep
- Conventions that differ from the tool's default.
- Pitfalls the agent would walk into, with the reason.
- Build, test and lint commands; where things live when a path cannot be guessed.
Cut
- What the agent can read from the code: directory listings, dependency lists, architecture overviews.
- Anything stated in another file that loads alongside this one. Two copies drift, and contradictory rules are followed arbitrarily.
- Generalities ("write clean code").
Right artifact?
| The content is | Put it in |
|---|---|
| A rule for part of the codebase | This file, with a quoted applyTo |
| A rule for every session | This file without applyTo, or AGENTS.md (agentsmd-author) |
| A multi-step procedure or one task's guidance | A skill (skill-author) |
| Something that must run at a fixed point or be blocked | A hook, or a permissions.deny setting; an instruction is not enforcement |
If the answer is not this file, say so to the user and stop; do not bend the content into a rule.