Skip to content

Add PR template#380

Open
mason-sharp wants to merge 2 commits intomainfrom
task/pr-template
Open

Add PR template#380
mason-sharp wants to merge 2 commits intomainfrom
task/pr-template

Conversation

@mason-sharp
Copy link
Member

PR template to be filled out with each PR in the future.

@coderabbitai
Copy link

coderabbitai bot commented Mar 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2084b795-da94-40da-b64a-f7c5f2358c03

📥 Commits

Reviewing files that changed from the base of the PR and between 879f170 and a9a36d4.

📒 Files selected for processing (1)
  • .claude/CLAUDE.md

📝 Walkthrough

Walkthrough

Adds two documentation files: a new GitHub pull request template at .github/pull_request_template.md (Conventional Commits guidance, structured PR sections) and a CLAUDE guidance file at .claude/CLAUDE.md recommending using the template and gh pr create --body-file workflow. No runtime code changes.

Changes

Cohort / File(s) Summary
Pull Request Template
.github/pull_request_template.md
Adds a PR template with sections: Summary, Changes, Testing, Checklist, Notes for Reviewers; enforces Conventional Commits examples and reviewer guidance. Documentation only; no code or API changes.
CLAUDE Guidance
.claude/CLAUDE.md
Adds guidance referencing the new PR template and recommends using gh pr create --body-file .github/pull_request_template.md to populate PR bodies. Documentation only.

Poem

🐇 I nibble lines and tidy the trail,
A template hop, neat as a snail's mail.
Sections in order, commits clear and bright,
Reviewers bounce by in morning light.
✨📜

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add PR template' accurately describes the main change: adding a pull request template file to the repository.
Description check ✅ Passed The description 'PR template to be filled out with each PR in the future' is directly related to the changeset, which adds template files for PR guidance.
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
  • Commit unit tests in branch task/pr-template

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: 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 27: Update the changelog checkbox link in
.github/pull_request_template.md so it no longer points to the
pgEdge/control-plane repository; replace the hardcoded URL in the line "- [ ]
[Changelog](https://github.com/pgEdge/control-plane/blob/main/docs/development/development.md#pull-requests)
entry added for user-facing behavior changes" with a generic instruction or a
relative/internal docs link (e.g., "See repository CONTRIBUTING or
docs/development for changelog entry") so contributors in pgEdge/spock are not
redirected to the control-plane repo.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 746f0d68-39da-4eb2-8045-320ba7d41c61

📥 Commits

Reviewing files that changed from the base of the PR and between 5b6732c and f1c2d4e.

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

@@ -0,0 +1,22 @@
<!-- PR title format: follow Conventional Commits style, e.g.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest adding this template to the main CLAUDE.md file, forcing Claude to use it for PR descriptions whenever needed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea, I added

@@ -0,0 +1,3 @@
## Pull Requests
When creating PRs, always read and follow the template at `.github/pull_request_template.md`.
Use `--body-file .github/pull_request_template.md` with `gh pr create`, then fill in each section appropriately based on the changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure this line is necessary: I wonder how many developers are so crazy as to allow AI to execute code on their machines, but hope not so much.
As an example, you may check the same PR for snowflake extension here: pgEdge/snowflake#37

@@ -0,0 +1,3 @@
## Pull Requests
When creating PRs, always read and follow the template at `.github/pull_request_template.md`.
Use `--body-file .github/pull_request_template.md` with `gh pr create`, then fill in each section appropriately based on the changes.
Copy link
Member

Choose a reason for hiding this comment

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

Addition of this file would conflict with anyone who has their own setup locally. It would be ongoing problem when creating commits or merging etc. I suggest we add a sample file (.claude/CLAUDE.md.example) instead and also have .claude/CLAUDE.md in .gitignore.

Copy link
Contributor

@danolivo danolivo Mar 12, 2026

Choose a reason for hiding this comment

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

@rasifr ,
Please, explain how it might cause problems?
As I see it, if you're using another AI, this file will be just ignored. If you use Claude and this repo, please use the standard PR format, or change this file in your personal fork. I can imagine someone wanting a personal fork, syncing it with us, and personal Claude settings for this project. It is possible, but it seems too strange and rare a case. Anyway, they have global Claude settings, and this specific one will be triggered only when a PR is created.

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.

3 participants