AN-447038 Add CLAUDE.md contributor guide for AI coding assistants#2149
Draft
ejsuncy wants to merge 2 commits intoadobe:masterfrom
Draft
AN-447038 Add CLAUDE.md contributor guide for AI coding assistants#2149ejsuncy wants to merge 2 commits intoadobe:masterfrom
ejsuncy wants to merge 2 commits intoadobe:masterfrom
Conversation
Supplements CONTRIBUTING.md with reviewer-enforced conventions (meta:enum coverage, deprecate-not-remove, example field-drift, needs-review label, reuse-over-reinvent, validation command set). Audience is both AI coding assistants and first-time human contributors. Closes adobe#2147
External contributors lack admin rights to apply labels on adobe/xdm, so the guidance was not actionable. README update to remove the same reference will follow in a separate PR.
This was referenced Apr 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #2147 · Companion issue: #2148 · Jira: AN-447038
Adds a root-level
CLAUDE.mdthat supplements (does not replace) CONTRIBUTING.md with the reviewer-enforced conventions that live outside the written spec — the ones first-time contributors (and AI coding assistants) only learn by having a PR sent back.Non-breaking, documentation-only. No schema changes.
Motivation
From a discussion on the XDM team Slack (2026-04-22): a growing share of PRs is authored with help from AI coding assistants (Claude, Copilot, Cursor), and those assistants have no persistent memory of repo conventions between sessions. Reviewers end up repeating the same feedback PR after PR — missing
meta:enumentries, examples with invented fields, removals instead of deprecations, missingneeds reviewlabel, etc.Adding a single root-level
CLAUDE.mdgives AI assistants and first-time human contributors a reviewer-shaped checklist they can internalize in one read.What's in the file
Closes #, reuse-over-reinvent,meta:enumcoverage, deprecate-not-remove, every example validates, every new schema has an example andmeta:status, don't hand-editdocs/reference/, add theneeds reviewlabel).validatefailures baseline, etc.).components/datatypes/,components/fieldgroups/,schemas/,docs/standards.md),meta:enumdocumentation for hard and soft enums, deprecation patterns, file placement, absolute$ref, naming conventions.xdm:prefixing, enum value coverage, sweep neighbors.components/,schemas/,extensions/, generateddocs/reference/.Companion issue
#2148 — separate proposal for automated CI checks so contributors don't have to depend on reading a doc. CLAUDE.md is the guide; CI is the guardrail. The two are complementary.
Validation
npm test— 2387 passing, 1 pendingnpm run lint— clean (CLAUDE.md is prettier-formatted; verified withnpx prettier --check CLAUDE.md)npm run validate— zero new failures vsmasterbaseline (58 pre-existing, all unrelated to this change — confirmed by stash-compare)npm run incompatibility-check— cleanBreaking changes
None. Documentation-only; no schema files, example files, or build config changed.
Non-goals
CONTRIBUTING.md— CLAUDE.md explicitly defers to it and says so in the first paragraph. If the two disagree, CONTRIBUTING.md wins.CLAUDE.mdis the emerging convention for "AI-assistant context file at repo root" (mirrorsAGENTS.md,GEMINI.md). The content is tool-agnostic.