Skip to content

chore: add pull request template#176

Merged
kongenpei merged 2 commits intomainfrom
codex/add-pr-template-guidance
Apr 1, 2026
Merged

chore: add pull request template#176
kongenpei merged 2 commits intomainfrom
codex/add-pr-template-guidance

Conversation

@kongenpei
Copy link
Copy Markdown
Collaborator

@kongenpei kongenpei commented Apr 1, 2026

Summary

Add a default GitHub pull request template in English for this repository.

Changes

  • Add .github/pull_request_template.md
  • Rephrase the existing Chinese template into concise English guidance

Test Plan

  • Verified the template file content locally

Related Issues

  • None

Summary by CodeRabbit

  • Chores
    • Added a pull request template to standardize contribution docs, including predefined sections for Summary, Changes, Test Plan, and Related Issues; includes comment placeholders and a pre-filled Test Plan checklist (unit tests passing, manual local verification).

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3aa61219-cad9-4d12-9358-219e80b9fe4f

📥 Commits

Reviewing files that changed from the base of the PR and between a860382 and 825d7c7.

📒 Files selected for processing (1)
  • .github/pull_request_template.md
✅ Files skipped from review due to trivial changes (1)
  • .github/pull_request_template.md

📝 Walkthrough

Walkthrough

Added a new GitHub pull request template file .github/pull_request_template.md that defines sections for Summary, Changes, Test Plan, and Related Issues, including HTML comment prompts and a pre-filled Test Plan checklist.

Changes

Cohort / File(s) Summary
GitHub Pull Request Template
​.github/pull_request_template.md
New PR template containing sections: Summary, Changes, Test Plan (with unchecked unit test and manual verification checklist items), and Related Issues.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped in with joy, a template to bring,

Sections and checks so contributors sing,
No more lost notes, just tidy delight,
Merge when you're ready — nibble tonight! 🥕

🚥 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 'chore: add pull request template' directly and clearly summarizes the main change—adding a GitHub pull request template file.
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
  • Commit unit tests in branch codex/add-pr-template-guidance

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

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Apr 1, 2026

Greptile Summary

This PR adds a .github/pull_request_template.md to standardize contribution documentation across the repository. The template provides four sections — Summary, Changes, Test Plan, and Related Issues — with guidance text safely tucked inside HTML comments so it never appears in the rendered PR body. A previously flagged concern about Closes #123 triggering unintended issue auto-closure has been avoided; the only reference to closing keywords is inside an HTML comment.

  • Added .github/pull_request_template.md with clear, concise English guidance
  • All instructional text is in HTML comments and won't appear in rendered PRs
  • The - None placeholder in Related Issues is neutral and won't trigger any GitHub automation
  • Template aligns with the structure already used by this PR itself

Confidence Score: 5/5

Safe to merge — template is well-structured, guidance text is in HTML comments, and no actionable auto-close keywords appear in the rendered body.

Single documentation file addition with no code changes. The previously raised concern about Closes #123 auto-closing issues is not present in this template. No logic, security, or correctness issues exist.

No files require special attention.

Important Files Changed

Filename Overview
.github/pull_request_template.md New PR template with Summary, Changes, Test Plan, and Related Issues sections; guidance text safely wrapped in HTML comments; no actionable issue-closing keywords in rendered content

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Developer opens new PR] --> B[GitHub auto-fills pull_request_template.md]
    B --> C{Author fills sections}
    C --> D[Summary\n1-3 sentence motivation]
    C --> E[Changes\nBullet list of edits]
    C --> F[Test Plan\nUnit tests / manual verification]
    C --> G[Related Issues\nOptional Closes/Fixes links]
    D & E & F & G --> H[PR submitted for review]
Loading

Reviews (2): Last reviewed commit: "fix: use safe related issue placeholder ..." | Re-trigger Greptile

@kongenpei kongenpei changed the title Add pull request template chore: add pull request template Apr 1, 2026
Copy link
Copy Markdown

@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: 1

🤖 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 16: Replace the executable issue-closing placeholder string "Closes `#123`"
with a neutral, non-keyword example (e.g., "Issue: 123" or "Refs:
example-issue") so it cannot accidentally close a real GitHub issue; locate the
literal "Closes `#123`" in the pull request template and swap it for a safe
placeholder string.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44f27bd5-4a7e-425f-9ada-a115633dc4d2

📥 Commits

Reviewing files that changed from the base of the PR and between 4c51a98 and a860382.

📒 Files selected for processing (1)
  • .github/pull_request_template.md

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@825d7c77e4ccc5fd578747e66e990b22d055da34

🧩 Skill update

npx skills add larksuite/cli#codex/add-pr-template-guidance -y -g

@kongenpei kongenpei requested a review from liangshuo-1 April 1, 2026 07:18
@kongenpei kongenpei merged commit d4e83df into main Apr 1, 2026
7 checks passed
@kongenpei kongenpei deleted the codex/add-pr-template-guidance branch April 1, 2026 07:27
tuxedomm pushed a commit that referenced this pull request Apr 3, 2026
* add pull request template

* fix: use safe related issue placeholder in PR template

---------

Co-authored-by: kongenpei <kongenpei@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants