fix: align docs for updated make targets#135
Conversation
WalkthroughUpdates developer docs (AGENTS.md, CONTRIBUTING.md, README.md) to split consolidated format/verify targets into granular make targets (black-format, bandit, check-types, pyright, docstyle, ruff, pylint, black-check), introduce Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![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)
README.md (1)
34-36: Note: This file usesmake install-toolsconsistently.README.md uses
make install-tools(lines 35, 388), which conflicts with CONTRIBUTING.md line 69 and AGENTS.md line 100 usingmake install-deps-test. As the primary user-facing documentation, README.md should be authoritative, suggesting the other files need correction.
🤖 Fix all issues with AI agents
In @AGENTS.md:
- Around line 66-67: AGENTS.md references two different Make targets ("make
install-tools" and "make install-deps-test"); inspect the Makefile to determine
the actual target name used for installing git hooks/dependencies, then update
AGENTS.md so both mentions use that single, correct target (replace either "make
install-tools" or "make install-deps-test" to match the Makefile) and ensure any
surrounding text still makes sense with the chosen target.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
AGENTS.mdCONTRIBUTING.mdREADME.md
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Update docs/, README.md, and AGENTS.md when modifying functionality or adding new features
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:59:09.244Z
Learning: Review AGENTS.md - this file contains agent-related guidelines and documentation
Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 47
File: src/lightspeed_evaluation/core/output/generator.py:140-145
Timestamp: 2025-09-11T12:47:06.747Z
Learning: User asamal4 prefers that non-critical comments are sent when actual code changes are pushed, not on unrelated commits.
📚 Learning: 2025-12-11T10:05:06.422Z
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Run make format, make verify, make check-types, make pyright, make docstyle, make bandit, and make test before completing code changes
Applied to files:
AGENTS.mdREADME.mdCONTRIBUTING.md
📚 Learning: 2025-12-11T10:05:06.422Z
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Update docs/, README.md, and AGENTS.md when modifying functionality or adding new features
Applied to files:
AGENTS.md
📚 Learning: 2025-11-24T16:59:09.244Z
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:59:09.244Z
Learning: Review AGENTS.md - this file contains agent-related guidelines and documentation
Applied to files:
AGENTS.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: tests (3.11)
- GitHub Check: tests (3.13)
- GitHub Check: tests (3.12)
🔇 Additional comments (5)
CONTRIBUTING.md (3)
47-53: Excellent addition documenting Git hooks.The hooks table clearly documents the automated workflow, helping developers understand what runs and when. This improves the developer experience by setting clear expectations.
68-69: No action needed. The make targets are used correctly for their respective purposes.install-tools(used in README.md and AGENTS.md for git hooks setup) andinstall-deps-test(used in CONTRIBUTING.md for full development setup) are different targets serving different purposes. CONTRIBUTING.md correctly usesinstall-deps-testbecause developers need the full test infrastructure, which depends oninstall-toolsand adds test dependencies. The targets are not inconsistent—they're appropriately scoped.Likely an incorrect or invalid review comment.
71-86: Well-structured quality check workflow.The split between individual checks and the unified
make pre-commitoption provides good flexibility for developers. Individual targets allow faster iteration during development, while the unified command ensures consistency with CI. All documented make targets have been verified to exist in the Makefile.AGENTS.md (1)
48-66: Consistent quality check workflow across documentation.The individual quality checks and unified
make pre-commitoption match the workflow documented in CONTRIBUTING.md. The addition of Git hooks information (line 66) is helpful context for AI agents.README.md (1)
387-406: Well-organized development workflow documentation.The Development Tools section clearly documents the workflow: installation (with hooks) → formatting → individual quality checks → unified pre-commit option → testing. The comments for each command (e.g., "Security scan (bandit)") provide helpful context.
asamal4
force-pushed
the
document-make-targets
branch
2 times, most recently
from
2691370 to
7cb5d66
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
AGENTS.md (1)
54-60: Minor: Inconsistent comment style with CONTRIBUTING.md.The individual make target comments here use simple descriptions (e.g.,
# Security scan), while CONTRIBUTING.md lines 77-83 include tool names in parentheses (e.g.,# Security scan (bandit)). Consider aligning the comment style between both files for consistency.♻️ Suggested alignment with CONTRIBUTING.md style
-make bandit # Security scan -make check-types # Type check -make pyright # Type check -make docstyle # Docstring style -make ruff # Lint check -make pylint # Lint check -make black-check # Check formatting +make bandit # Security scan (bandit) +make check-types # Type check (mypy) +make pyright # Type check (pyright) +make docstyle # Docstring style (pydocstyle) +make ruff # Lint check (ruff) +make pylint # Lint check (pylint) +make black-check # Check formatting (black)Alternatively, remove the redundant tool names from CONTRIBUTING.md to match this simpler style.
CONTRIBUTING.md (1)
77-83: Minor: Consider simplifying redundant tool name annotations.Several make targets already clearly indicate their tool (e.g.,
make bandit,make ruff,make pylint,make pyright), making the tool names in parentheses redundant. Onlycheck-types,docstyle, andblack-checkbenefit from the clarification.This also differs from AGENTS.md lines 54-60, which use simpler comments without tool names in parentheses.
♻️ Option 1: Remove redundant tool names
-make bandit # Security scan (bandit) +make bandit # Security scan make check-types # Type check (mypy) -make pyright # Type check (pyright) +make pyright # Type check make docstyle # Docstring style (pydocstyle) -make ruff # Lint check (ruff) +make ruff # Lint check -make pylint # Lint check (pylint) +make pylint # Lint check make black-check # Check formatting (black)♻️ Option 2: Align AGENTS.md to match this style (see AGENTS.md comment)
Add tool names in parentheses to AGENTS.md lines 54-60 to match this format.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
AGENTS.mdCONTRIBUTING.mdREADME.md
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Update docs/, README.md, and AGENTS.md when modifying functionality or adding new features
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Run make format, make verify, make check-types, make pyright, make docstyle, make bandit, and make test before completing code changes
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:59:09.244Z
Learning: Review AGENTS.md - this file contains agent-related guidelines and documentation
Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 47
File: src/lightspeed_evaluation/core/output/generator.py:140-145
Timestamp: 2025-09-11T12:47:06.747Z
Learning: User asamal4 prefers that non-critical comments are sent when actual code changes are pushed, not on unrelated commits.
📚 Learning: 2025-12-11T10:05:06.422Z
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Run make format, make verify, make check-types, make pyright, make docstyle, make bandit, and make test before completing code changes
Applied to files:
AGENTS.mdCONTRIBUTING.md
📚 Learning: 2025-12-11T10:05:06.422Z
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T10:05:06.422Z
Learning: Update docs/, README.md, and AGENTS.md when modifying functionality or adding new features
Applied to files:
AGENTS.md
📚 Learning: 2025-11-24T16:59:09.244Z
Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:59:09.244Z
Learning: Review AGENTS.md - this file contains agent-related guidelines and documentation
Applied to files:
AGENTS.md
🔇 Additional comments (3)
AGENTS.md (1)
48-67: LGTM! Clear documentation of the new granular workflow.The updated quality checks workflow is well-documented and provides clear guidance on the new make targets. The distinction between
make pre-commit(consolidated) and individual check targets is helpful.CONTRIBUTING.md (2)
47-53: LGTM! Well-structured Git hooks documentation.The new "Installed Hooks" section clearly documents what runs when, using a clean table format that's easy to scan.
68-86: LGTM! Clear setup instructions with new make targets.The updated setup instructions clearly document the new workflow, including the distinction between consolidated (
make pre-commit) and individual check targets. The progression from formatting → checks → tests is logical and easy to follow.
asamal4
force-pushed
the
document-make-targets
branch
from
7cb5d66 to
6473881
Compare
asamal4
changed the title
2 participants
Description
Update docs for updated make targets. Add git hook info to contribution guide.
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.