Skip to content

Commit 6c88e66

Browse files
cliffhallclaude
andcommitted
docs: scope the purpose-header rule to source files; drop evidence wording deferred to S6
Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: cliffhall <[email protected]>
1 parent 9511de6 commit 6c88e66

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

‎AGENTS.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,17 @@ A server may carry its own `AGENTS.md` for guidance that only applies inside it
5656
it reads a file in that directory, not at session start, so **a rule that
5757
applies repo-wide goes in this file, never only in a nested one.**
5858

59-
### New and rewritten files open with a purpose header
59+
### New and rewritten source files open with a purpose header
6060

61-
A file you create, or substantially rewrite, opens with a comment stating what
62-
the file is for and the reasoning behind it: the first comment in the file,
61+
A source file you create, or substantially rewrite (code, tests, scripts,
62+
workflows, configuration), opens with a comment stating what the file is for
63+
and the reasoning behind it: the first comment in the file,
6364
**after any shebang**. `#!/usr/bin/env node` must stay on line 1 of an
6465
executable entry point, or the published bin stops working. This is not a bulk
6566
migration: files you only touch in passing keep their current form. Read that
6667
header rather than restating its reasoning in this file, since a duplicated
67-
rationale goes stale silently.
68+
rationale goes stale silently. A Markdown document states its purpose in its
69+
opening paragraph instead, as this one does.
6870

6971
## Development setup
7072

@@ -163,8 +165,8 @@ Every PR answers the checklist in
163165
[`.github/pull_request_template.md`](./.github/pull_request_template.md):
164166
the MCP documentation was read for the feature touched, the change follows MCP
165167
security best practices, the server's README is updated, and a **server-facing
166-
change was tested with an LLM client**, with what was asked and what came back
167-
recorded in the PR.
168+
change was tested with an LLM client**, with the scenarios tested named under
169+
the template's "How Has This Been Tested?" heading.
168170

169171
## Maintenance rules
170172

0 commit comments

Comments
 (0)