Conversation
Adds a standard pull request template to help contributors provide necessary context, design decisions, and testing checklists for new features and bug fixes. cc: @aliev @Nash0x7E2 @d3xvn
📝 WalkthroughWalkthroughA GitHub pull request template has been added to standardize PR submissions. The template includes sections for motivation, included changes, design decisions, and a checklist with unit tests, linting, type checking, and documentation validation commands. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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)
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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
18-18: Preferpytestover the legacypy.testentry point.
py.testis the old entry-point name from early pytest versions; for some old versions of pytest the executable was namedpy.testinstead ofpytest. All modern pytest releases installpytestas the canonical command. Updating touv run pytestkeeps the template idiomatic for new contributors.✏️ Suggested change
-- [ ] `uv run py.test -m "not integration" -n auto` — all unit tests pass +- [ ] `uv run pytest -m "not integration" -n auto` — all unit tests pass🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/PULL_REQUEST_TEMPLATE.md at line 18, Update the PR template checklist item that uses the legacy test runner name: replace the command string "uv run py.test -m \"not integration\" -n auto" with the modern canonical entry point "uv run pytest -m \"not integration\" -n auto" so contributors use pytest rather than the old py.test executable.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 20: The checklist entry currently says "`uv run ruff check --fix` — no
lint issues", which can silently modify files; update the PR template so the
checklist either uses a read-only check ("`uv run ruff check` — no lint issues")
or keeps "`uv run ruff check --fix`" but adds a clear note that any auto-applied
changes must be committed (e.g., append "If you run with --fix, commit any
modified files before submitting"); modify the single-line checklist text
accordingly to ensure contributors know to commit fixes, referencing the
existing checklist item text "`uv run ruff check --fix`".
- Around line 18-21: Remove the duplicate/incorrect checklist entry that runs
redundant checks: delete the line containing "`uv run python dev.py check`" and
either (a) replace it with the correct omnibus command "`uv run dev.py check`"
if you want a single combined validation, or (b) remove it entirely and keep the
explicit individual commands (`uv run py.test -m "not integration" -n auto`, `uv
run ruff check --fix`, and `uv run mypy --install-types --non-interactive -p
vision_agents`) so tests, lint, and types are run only once; ensure the
preserved command uses the correct syntax "`uv run dev.py check`" if you choose
the omnibus option.
---
Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 18: Update the PR template checklist item that uses the legacy test
runner name: replace the command string "uv run py.test -m \"not integration\"
-n auto" with the modern canonical entry point "uv run pytest -m \"not
integration\" -n auto" so contributors use pytest rather than the old py.test
executable.
Adds .github/PULL_REQUEST_TEMPLATE.md\ to standardise contributions with sections for motivation, included changes, design decisions, and testing checklists.
cc: @aliev @Nash0x7E2 @d3xvn
Summary by CodeRabbit