Skip to content

docs(claude): clarify .claude/ markdown exception#1223

Merged
John-David Dalton (jdalton) merged 1 commit intomainfrom
docs/clarify-claude-md-policy
Apr 17, 2026
Merged

docs(claude): clarify .claude/ markdown exception#1223
John-David Dalton (jdalton) merged 1 commit intomainfrom
docs/clarify-claude-md-policy

Conversation

@jdalton
Copy link
Copy Markdown
Contributor

@jdalton John-David Dalton (jdalton) commented Apr 17, 2026

Summary

Small policy fix to CLAUDE.md.

The old "Documentation Policy" text read as if every .md file under .claude/ was forbidden, but the Claude harness actually reads a bunch of them as config (agent definitions, command metadata, SKILL.md entrypoints, skill references). Those have been checked in all along, and we want them to be — so the stated policy and the checked-in files disagreed.

This PR rewrites the section so the rule matches reality:

  • harness-config markdown under .claude/agents, .claude/commands, .claude/hooks, .claude/skills is allowed
  • ad-hoc analysis/session notes dropped into .claude/ are still disallowed, same as before
  • the rest of the repo rule (no litter, allowed locations) is unchanged

Pure doc change; no code touched.

Test plan

  • grep of .claude/*.md files matches the carve-out described in the new text
  • CI green

Note

Low Risk
Documentation-only change with no runtime/code impact; risk is limited to potential policy interpretation changes.

Overview
Updates CLAUDE.md’s Documentation Policy to explicitly allow markdown files under .claude/agents/, .claude/commands/, .claude/hooks/, and .claude/skills/ as Claude harness configuration, while continuing to forbid ad-hoc analysis/session notes in .claude/ and keeping the rest of the “no doc sprawl” rule unchanged.

Reviewed by Cursor Bugbot for commit 276a40c. Configure here.

The old policy text read as if every .md under .claude/ was banned,
but the Claude harness actually reads files like `SKILL.md`,
`agents/*.md`, `commands/*.md`, and `hooks/*/README.md` as its own
configuration. We've been checking those in all along.

Updates the Documentation Policy section so the stated rule matches
what we actually do: harness-config markdown under .claude/agents,
.claude/commands, .claude/hooks, .claude/skills is allowed.
Ad-hoc analysis/session notes dropped under .claude/ are still
disallowed, same as before.
@jdalton John-David Dalton (jdalton) merged commit 5e24716 into main Apr 17, 2026
6 checks passed
@jdalton John-David Dalton (jdalton) deleted the docs/clarify-claude-md-policy branch April 17, 2026 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants