Repository navigation
docs: add CLAUDE.md (RM-2185) (RM-2177) - #66
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0135NF9znw5wkTjtATyd1n52
🤖 CodeAnt AI — Review Status
|
Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes.
|
| Layer / File(s) | Summary |
|---|---|
Add repository-specific guidance CLAUDE.md, .codacy.yml |
CLAUDE.md records command verification status, repository architecture, GPU and CUDA constraints, and contribution notes. .codacy.yml excludes CLAUDE.md from Codacy analysis. |
Priority:
Estimated code review effort: 1 (Trivial) | ~5 minutes
Change: Other
Merge Risk: 
Low · up to 29b52
-
Adding
.codacy.ymlschedules GPU validation for a Codacy configuration change, adding a hardware-dependent CI step. The PR is otherwise limited to guidance and configuration, so this is a bounded operational risk.
Architecture risk: 
Low · up to 29b52
-
The change affects 1 system.
Changed systems:
CLAUDE.mdArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — CLAUDE.md (service) was modified; 1 changed file maps to changed impact.
Before / after behavior
- observed — Modified behavior in CLAUDE.md: Adds
AGENTS.mdas imported guidance and states thatCLAUDE.mdcontains Claude-specific notes rather than duplicating repository-wide guidance. - observed — Modified behavior in CLAUDE.md: Adds a command table with verification status and environment, distinguishing CPU checks reported as verified from CUDA/GPU-dependent commands reported as not run. Also records additional CI checks and runner distinctions.
- observed — Modified behavior in CLAUDE.md: Adds an architecture map describing the roles of the
kernels/,tools/,fixtures/,recipes/,docs/, andresults/directories. - observed — Modified behavior in CLAUDE.md: Adds repository invariants and non-goals covering CUDA file placement, self-hosted GPU workflow restrictions, GPU relevance classification, a 2 GiB free-VRAM floor, NVML missing-value distinction, SPDX headers, and manifest/publish-list status.
-
Pre-merge checks: 
3 · 
2
-
Failed checks: 2 warnings Passed checks: 3 passed-
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
-
Full details: Linked Issues check
-
Explanation
RM-2185 requires build, test, and benchmark commands to run and be confirmed at HEAD, with GPU requirements identified.
CLAUDE.mdidentifies the GPU requirements, but marks the CUDA build, GPU binaries and benchmarks, Green Context report check, and Compute Sanitizer asnot run. The CPU command rows and architecture and invariant sections satisfy the corresponding documentation objectives. RM-2177 also requires verified commands and no unverifiable claims.Resolution
Run the GPU-required build, benchmark, report-check, and Compute Sanitizer commands on the required CUDA 13.3 and RTX 5080 environment. Update
CLAUDE.mdwith the confirmed HEAD results, or obtain a change to the linked acceptance requirement.
Full details: Out of Scope Changes check
-
Explanation
The whole-PR diff adds
.codacy.ymlin addition toCLAUDE.md. The Codacy exclusion changes repository analysis configuration and does not document Claude-specific repository guidance. RM-2185 requests a root-levelCLAUDE.mdwith only Claude-specific notes, and RM-2177 lists CI changes as out of scope. The new file also causes.codacy.ymlto be classified as GPU-relevant because it is not inCPU_FILES.Resolution
Remove
.codacy.ymlfrom this pull request unless the linked issue is expanded to include Codacy configuration. Keep the requested guidance inCLAUDE.md.
-
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
There was a problem hiding this comment.
This PR adds a single documentation file, CLAUDE.md, containing Claude-specific operational notes for the repository. The file is well-structured, accurately describes the repo architecture, and correctly avoids duplicating content already in AGENTS.md by importing it with @AGENTS.md.
No logic errors, security vulnerabilities, crashes, or other merge-blocking defects were found. The command table is clear about what has and hasn't been verified, the invariants section accurately reflects CI security constraints (e.g., pull_request_target, persist-credentials: false, SHA-pinned actions), and the gotchas section correctly calls out the GPU serialization risk.
Verdict: No blocking issues. Ready to merge.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
Up to standards ✅🟢 Issues
|
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0135NF9znw5wkTjtATyd1n52
CodeAnt Nitpicks2 code suggestions1. This command fails in a fresh checkout because
|
CodeAnt PR Risk: Low Risk
Assessed commit: |
…M-2185) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0135NF9znw5wkTjtATyd1n52
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0135NF9znw5wkTjtATyd1n52
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…RM-2185) Docs-only; no build run. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0135NF9znw5wkTjtATyd1n52
User description
Summary
Adds
CLAUDE.mdwith Claude-specific notes: a command table with verified / not-run status, an architecture map, invariants and non-goals, and gotchas. It importsAGENTS.mdinstead of duplicating it. No other files are touched; there is no package manifest or publish list to update, and sources here use no SPDX headers.Verified
Ran locally (Python 3.13, CMake 3.28, shellcheck 0.11.0, actionlint 1.7.12, no GPU or CUDA): the CUDA-OFF CMake configure, all
ci-cpu.ymlPython checks, the compute-sanitizer runner self-check, the "Kernel tree is complete" step, shellcheck on the recipe and kernel-tool scripts, and actionlint on the workflows.Not run: the CUDA build, the GPU benchmarks, the Green Context report check, and Compute Sanitizer. They need nvcc, CUDA 13.3 and the RTX 5080.
Closes RM-2185
Generated by Claude Code
Summary by cubic
Adds
CLAUDE.mdwith Claude-specific notes, importingAGENTS.mdvia@AGENTS.mdto avoid duplication. Closes RM-2185.The guide covers a verified command table, an architecture map, invariants and non-goals, and gotchas. It marks 13 commands as verified on a CPU-only machine and 6 as not run (they need nvcc, CUDA 13.3, and the RTX 5080), including full binary paths and the actionlint setup note. It also records which CI jobs run on the self-hosted GPU runner versus hosted
ubuntu-latestrunners, the CPU-only gate allowlist, the VRAM headroom floor, and thepull_request_targettrust boundary.Adds
.codacy.ymlto excludeCLAUDE.mdfrom Codacy analysis, since Codacy does not read.gitignore; because.codacy.ymlis not in the gate's CPU allowlist, a PR touching it is flagged GPU-relevant.Written for commit f464ca9. Summary will update on new commits.
CodeAnt-AI Description
Add Claude guidance for repository checks and GPU workflows
What Changed
CLAUDE.mdfrom Codacy analysis.Impact
✅ Clearer CPU checks to run before pushing✅ Clearer GPU runner safety requirements✅ Fewer Codacy findings from Claude guidance💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.