HDDS-15790. Add AGENTS.md and CLAUDE.md - #541
Merged
Merged
Conversation
Co-Authored-By: Claude Code <noreply@anthropic.com>
jojochuang
reviewed
Sep 29, 2026
Copilot stopped reviewing on behalf of
jojochuang due to an error
September 30, 2026 04:09
Contributor
There was a problem hiding this comment.
Note
Copilot was unable to run its full agentic suite in this review.
Copilot review overview
Review effort: Lite
Findings: None
What changed in this PR
Adds agent/instructions documentation and updates spell-check configuration to recognize a new term used in docs/guidelines.
Changes:
- Add
AGENTS.mdwith contributor/agent working guidelines for the repo. - Add
CLAUDE.mdas a pointer toAGENTS.md. - Add
ATXto the cspell wordlist.
| File | Description |
|---|---|
| cspell.yaml | Whitelists ATX to prevent spell-check noise in docs/instructions. |
| CLAUDE.md | Introduces a short pointer file intended to refer readers/tools to AGENTS.md. |
| AGENTS.md | Adds detailed repository-specific working style, commands, and boundaries documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
|
Merged with a small update. Thanks @shuan1026 |
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.
What changes were proposed in this pull request?
Add
AGENTS.mdgiving coding agents the local commands and conventions for this repo: preview (Docker/pnpm, port 3001), lint, build, spell check, branch rules (mastervsasf-site), and change boundaries (e.g. don't touchversioned_docs/outside backports).CLAUDE.mdis added as a symlink toAGENTS.md, matching the canonical-file + symlink conventionapache/ozoneestablished in HDDS-15316.Note: the content of
AGENTS.mdis mainly adapted from HDDS-15316 (apache/ozone#10302).Also adds
ATXtocspell.yaml's word list, sinceAGENTS.mduses the Markdown term "ATX headings" and cspell otherwise flags it as unknown.What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-15790
How was this patch tested?
pnpm exec markdownlint AGENTS.mdpnpm buildCLAUDE.mdis a real symlink, not a copy (ls -l,git ls-files -s)