docs: initialize CLAUDE.md with project overview and commands#3
Merged
docs: initialize CLAUDE.md with project overview and commands#3
Conversation
ameynert
had a problem deploying
to
github-actions-snakemake-linting
GitHub Actions
Failure
📝 WalkthroughWalkthroughThe Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
ameynert
force-pushed
the
am_02_claude_md
branch
from
b01de52 to
639072a
Compare
ameynert
temporarily deployed
to
github-actions-snakemake-linting
GitHub Actions
Inactive
Replaces the template setup placeholder with actual project guidance: environment setup (uv + pixi), common commands, architecture overview, CLI registration pattern, and tool pipeline execution order. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ameynert
force-pushed
the
am_02_claude_md
branch
from
639072a to
8b16ab6
Compare
ameynert
temporarily deployed
to
github-actions-snakemake-linting
GitHub Actions
Inactive
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CLAUDE.md (1)
119-119:⚠️ Potential issue | 🟠 MajorFix inconsistent pre-commit command in commit rules.
This line conflicts with Line 19 and will likely fail from repo root without
--directory divref. Use the same required command in both places.Based on learnings: "Run `uv run --directory divref poe fix-and-check-all` before each commit; all checks must pass".Proposed doc fix
-- Run `uv run poe fix-and-check-all` before each commit; all checks must pass +- Run `uv run --directory divref poe fix-and-check-all` before each commit; all checks must pass🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` at line 119, Update the inconsistent pre-commit command in CLAUDE.md so both occurrences match: replace the string "Run `uv run poe fix-and-check-all` before each commit; all checks must pass" with "Run `uv run --directory divref poe fix-and-check-all` before each commit; all checks must pass" to match the command used on Line 19 and ensure running from the repo root works consistently.
🧹 Nitpick comments (1)
CLAUDE.md (1)
155-158: Consider linking README sync explicitly in this docs PR or a follow-up PR.You added/changed usage guidance here; adding a short README alignment task/link will keep contributor docs consistent.
Based on learnings: "Update README.md when usage patterns change".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` around lines 155 - 158, Add an explicit README sync task/link to the documentation checklist you modified: update the checklist entry "README.md (if usage patterns changed)" in CLAUDE.md to include either a direct link to the README update instructions or a TODO that references a follow-up PR/issue for aligning README usage guidance; ensure the checklist text clearly instructs contributors to update README when usage patterns change and, if appropriate, add a short example or link to the README section to be updated so reviewers can verify README alignment during docs PRs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CLAUDE.md`:
- Around line 39-51: The fenced code block showing the repository tree in
CLAUDE.md is missing a language tag and triggers MD040; update the opening fence
for that block from ``` to ```text so the repo tree is treated as plain text
(leave the block content unchanged and keep the closing ``` intact).
---
Outside diff comments:
In `@CLAUDE.md`:
- Line 119: Update the inconsistent pre-commit command in CLAUDE.md so both
occurrences match: replace the string "Run `uv run poe fix-and-check-all` before
each commit; all checks must pass" with "Run `uv run --directory divref poe
fix-and-check-all` before each commit; all checks must pass" to match the
command used on Line 19 and ensure running from the repo root works
consistently.
---
Nitpick comments:
In `@CLAUDE.md`:
- Around line 155-158: Add an explicit README sync task/link to the
documentation checklist you modified: update the checklist entry "README.md (if
usage patterns changed)" in CLAUDE.md to include either a direct link to the
README update instructions or a TODO that references a follow-up PR/issue for
aligning README usage guidance; ensure the checklist text clearly instructs
contributors to update README when usage patterns change and, if appropriate,
add a short example or link to the README section to be updated so reviewers can
verify README alignment during docs PRs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+39
to
+51
| ``` | ||
| divref/ # Python package (uv-managed) | ||
| divref/ | ||
| main.py # CLI entry point; registers tools in _tools list | ||
| haplotype.py # Shared Hail utilities (HailPath alias, haplotype helpers) | ||
| tools/ # One module per CLI subcommand | ||
| tests/ # pytest tests | ||
| pyproject.toml # Package deps, ruff/mypy/pytest config | ||
| workflows/ # Snakemake workflows | ||
| download.smk # Template download workflow | ||
| config/config.yml # Workflow configuration | ||
| pixi.toml # Workspace config (snakemake + hail environments) | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to the fenced code block.
This triggers markdownlint MD040 (fenced-code-language). Add text for the repository tree block.
Proposed doc fix
-```
+```text
divref/ # Python package (uv-managed)
divref/
main.py # CLI entry point; registers tools in _tools list
@@
pixi.toml # Workspace config (snakemake + hail environments)</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 39-39: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CLAUDE.md` around lines 39 - 51, The fenced code block showing the repository
tree in CLAUDE.md is missing a language tag and triggers MD040; update the
opening fence for that block from ``` to ```text so the repo tree is treated as
plain text (leave the block content unchanged and keep the closing ``` intact).
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
CLAUDE.mdwith actual project guidanceuvfor the Python toolkit,pixifor the full workspace)Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit