Skip to content

chore: add PR template#367

Open
aniruddhaadak80 wants to merge 1 commit intoGetStream:mainfrom
aniruddhaadak80:feature/add-pr-template
Open

chore: add PR template#367
aniruddhaadak80 wants to merge 1 commit intoGetStream:mainfrom
aniruddhaadak80:feature/add-pr-template

Conversation

@aniruddhaadak80
Copy link

@aniruddhaadak80 aniruddhaadak80 commented Feb 21, 2026

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

  • Chores
    • Updated GitHub pull request template with sections for motivation, design decisions, and validation checklist.

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
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

📝 Walkthrough

Walkthrough

A 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

Cohort / File(s) Summary
GitHub Configuration
.github/PULL_REQUEST_TEMPLATE.md
Added new pull request template with sections for Motivation, What's included, Design decisions, and a validation checklist including unit-test, lint, type-check, and documentation commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

The template stares back,
A hollow mold for intention—
Words to be filled, bleached white,
Each checkbox a small confession,
Before the merge takes us under.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a PR template file to standardize contributions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)

18-18: Prefer pytest over the legacy py.test entry point.

py.test is the old entry-point name from early pytest versions; for some old versions of pytest the executable was named py.test instead of pytest. All modern pytest releases install pytest as the canonical command. Updating to uv run pytest keeps 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant