docs: refactor AGENTS.md using progressive disclosure principles#831
Open
docs: refactor AGENTS.md using progressive disclosure principles#831
Conversation
Owner
Author
|
/reviewbot |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Review Summary
- .claude/ai-instructions.md: Added AI assistant instructions covering task execution and technical guidelines.
- .claude/git-workflow.md: Added detailed Git workflow guidelines, commit message conventions, AI attribution rules, and PR requirements.
- .claude/go-style.md: Added Go style guidelines including formatting, naming, and code organization.
- .claude/security.md: Added security best practices for secrets management and dependency auditing.
- .claude/testing.md: Added testing guidelines for Go tests, running tests, coverage expectations, and test patterns.
- AGENTS.md: Refactored to a concise root file with a quick‑reference command table and links to the newly added detailed documentation files, reducing line count from 118 to 24.
Suggestions
- Ensure that the relative links (e.g.,
.claude/go-style.md) resolve correctly in the repository’s rendering environment; using./.claude/...can be more explicit. - Consider adding a brief introductory sentence before the link list to guide readers on the purpose of the linked documents.
Overall, the restructuring follows progressive disclosure principles and improves maintainability. The PR can be approved.
Split bloated AGENTS.md into root file with categorized linked files. - Keep only essentials in root (commands, critical overrides) - Move Go style, testing, git workflow, security, and AI instructions to separate files - Remove duplicate JavaScript formatting entry - Reduce root file from 118 to 29 lines Assisted-by: GLM 4.7 via Claude Code Reviewbot-request: yes Signed-off-by: Xe Iaso <me@xeiaso.net>
Xe
force-pushed
the
refactor/agents-md-progressive-disclosure
branch
from
eb0d0f0 to
a188191
Compare
Contributor
|
The latest Buf updates on your PR. Results from workflow Go / build (pull_request).
|
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
1 participant
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
Split bloated AGENTS.md into root file with categorized linked files following progressive disclosure principles.
Test plan
.claude/