Conversation
Reviewer's GuideAdds AI-assistant guidance documentation in CLAUDE.md describing development workflows, tooling, code style, architecture, and dependency management for the StArMap client, plus an AGENTS.md file that points other AI tools at the same guidance. Flow diagram for AI tools discovering CLAUDE.md guidanceflowchart TD
A["AI coding tool scans repository"] --> B{File discovered}
B -->|CLAUDE.md| C["Read CLAUDE.md for guidance"]
B -->|AGENTS.md| D["Follow pointer to CLAUDE.md"]
D --> C
C --> E["Apply development commands, code style, and architecture rules"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Collaborator
Author
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- AGENTS.md is currently a plain file containing the text
CLAUDE.md; if the intent is a real symlink for tooling, consider committing it as an actual symlink or adding a brief header that explains it is an alias to CLAUDE.md so tools and humans don’t misinterpret it.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- AGENTS.md is currently a plain file containing the text `CLAUDE.md`; if the intent is a real symlink for tooling, consider committing it as an actual symlink or adding a brief header that explains it is an alias to CLAUDE.md so tools and humans don’t misinterpret it.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
d80bf33 to
fd33146
Compare
Add CLAUDE.md with project guidance for Claude Code, covering development commands (tox environments, running single tests), code style rules (black, isort, flake8, mypy strict, 100% coverage), architecture overview (client, models, session, providers), and dependency management (pip-tools workflow). AGENTS.md is a symlink to CLAUDE.md so other AI coding tools can also discover the guidance. Refers to SPSTRAT-736 Signed-off-by: Jonathan Gangi <jgangi@redhat.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
Add CLAUDE.md with project guidance for Claude Code, covering development commands (tox environments, running single tests), code style rules (black, isort, flake8, mypy strict, 100% coverage), architecture overview (client, models, session, providers), and dependency management (pip-tools workflow).
AGENTS.md is a symlink to CLAUDE.md so other AI coding tools can also discover the guidance.
Refers to SPSTRAT-736
Summary by Sourcery
Add AI-assistant guidance documentation for working with the StArMap client repository and expose it via a generic entrypoint file for other tools.
Documentation:
Chores: