Skip to content

New PR template #1260

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
kennethshsu wants to merge 8 commits into
base: main
Choose a base branch
from
+27 −6
Open

New PR template #1260

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2b35ec6
revised PR template in accordance with governing doc
kennethshsu Aug 31, 2026
acd3df7
Spacing
kennethshsu Aug 31, 2026
0378e5e
Format
kennethshsu Aug 31, 2026
8c25da6
Added url to governing doc
kennethshsu Sep 1, 2026
f4fdfc8
Shorten the PR subject prefix list
kennethshsu Sep 1, 2026
5ff14c7
Words
kennethshsu Sep 1, 2026
cfb1c2c
capitalization
kennethshsu Sep 1, 2026
2015105
words and typo
kennethshsu Sep 1, 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
33 changes: 27 additions & 6 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,36 @@
## Summary of Changes
## Summary of Changes


## Related GitHub Issue(s)

## Related GitHub Issue(s)
<!-- Use keywords like close/closes/closed or fix/fixes/fixed to close the issue automatically -->

## Additional Context for Reviewers

## AI/LLM Usage
<!-- Declare and briefly describe any AI/LLM assistance used and the extent of usage during development of this PR. -->



<!-- Do not edit anything below this. -->
## Additional Context for Reviewers



<!-- Do not edit anything below until the ticket is open. Checklists below. -->

## Submitter's Checklist
- [ ] I have reviewed and am adhering to the standards outlined in the project [Governing Doc](https://github.com/casact/chainladder-python/blob/main/docs/library/governance.md).
- [ ] The PR subject title summarizes the changes, with one proper prefix (`[FIX]`, `[FEAT]`, `[DOCS]`, `[TST]`, `[CHORE]`, or `[BRK]`).
- [ ] I am a human (not a bot), and this PR form is written by a human.

## Reviewer's Checklist
- [ ] The implementation addresses the associated issue(s).
- [ ] The implementation is appropriate, maintainable, and follows ARCHITECTURE.md.
- [ ] PR subject title has the proper prefix and the subject is appropriate.
- [ ] Relevant issue(s) are linked.
- [ ] AI/LLM usage is disclosed and appropriate.
- [ ] Documentation and tests are appropriate.
- [ ] Additional reviewer is requested or not needed.
- [ ] CI tests passed or failure are acceptable.



## Checklist
- [ ] I passed tests locally for both code (`uv run pytest`) and documentation changes (`uv run --directory docs jb build . --builder=custom --custom-builder=doctest`)

@genedan genedan Sep 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd recommend adding a bullet Submitter's Checklist that replaces this one. We now have a pre-commit hook that can one-shot all the workflows locally:

I passed all pre-commit checks prior to push (with a link to the list of workflows we deploy in the Governing Doc).

@kennethshsu kennethshsu Sep 1, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Do you think this is necessary? We already have the CI tests that run automatically, and there's also the last bullet on the reviewer's list "CI tests passed or failure are acceptable"

Loading