Skip to content

Add PR template #380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mason-sharp wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add PR template #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
879f170
Add PR template
mason-sharp Mar 6, 2026
a9a36d4
Try to have Claude use PR template
mason-sharp Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .claude/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy Markdown
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.

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

Copy link
Copy Markdown
Member

@rasifr rasifr Mar 12, 2026

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
Copy Markdown
Contributor

@danolivo danolivo Mar 12, 2026 •
edited
Loading

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.

22 changes: 22 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- PR title format: follow Conventional Commits style, e.g.
Copy link
Copy Markdown
Contributor

@danolivo danolivo Mar 10, 2026

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
Copy Markdown
Member Author

@mason-sharp mason-sharp Mar 11, 2026

Choose a reason for hiding this comment

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

Good idea, I added

feat: add new postgres minor release images
fix: correctly mark stale instances as unknown
docs: add database migration guide
Common types: feat, fix, docs, chore, test, refactor, build(release)
See: https://www.conventionalcommits.org/en/v1.0.0/#summary
-->
## Summary

<!-- Briefly describe what changed and why. Link to a GitHub issue if appropriate. -->

## Checklist

- [ ] Tests added or updated (unit, regression, integration as needed)
- [ ] Docs/README updated (or not, with justification)
- [ ] Issue is linked (branch name or URL in PR description)
- [ ] Security checks (no secrets, vulnerabilities)
- [ ] Breaking changes (if any) are clearly called out in the PR description

## Notes for Reviewers

<!-- Instructions to help with the review including known limitations, design rationale, or follow-up tasks. -->
Loading