docs(#4887): rework agent guides and add CLAUDE.md - #4888
Open
tenthe wants to merge 2 commits into
Open
Conversation
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.
Purpose
Overview
This PR reworks the repository's agent instruction files so that they carry the facts an AI coding agent cannot derive from the code, and adds a
CLAUDE.mdso Claude Code loads them. The root guide now states the toolchain, build and CI contract; the module guides gain concrete recipes; duplicated content across the UI and design docs is consolidated with an explicit precedence order.Changes
CLAUDE.md, which importsAGENTS.mdand explains that nested guides must be read before editing in their directories.AGENTS.mdaround the toolchain (JDK 25 build, Java 17 language level), the fast test loop versus the rootverifythat alone runs the license check, code standards, commit conventions and an index of all nested guides.security-triageskill under.claude/skills/, so it loads only for vulnerability work.service-core), an endpoint (rest), an extension (extensions) and a storage type (storage-couchdb); removes the per-module validation sections now covered by the root.DESIGN.md,PRODUCT.md,ui/STYLEGUIDE.mdandui/AGENTS.mdwith a stated hierarchy (DESIGN.mdis normative for tokens and rules), corrects the UI component list and layout package name, and removes verbatim duplicates.CLAUDE.mdand.claude/**from the RAT license check, matching the existingAGENTS.mdrule.Remarks
PR introduces (a) breaking change(s): yes
PR introduces (a) deprecation(s): yes