Skip to content

docs: add squash commit guidance to PR template #9

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
JSRRosenbaum wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −0
Open

docs: add squash commit guidance to PR template #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions .github/workflows/pull_request_template.md → .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
## Description
Fixes / Relates to Issue: #

Briefly explain why this PR exists, what changed, and what is intentionally out of scope.

## Suggested squash commit

```text
<type>: <short imperative summary>

<why this change exists in one short paragraph>

- <major change 1>
- <major change 2>
- <major change 3>

Verified with <local checks>, <manual smoke>, and <CI if applicable>.
```

## Type of Change
- [ ] 🐛 Bug Fix
- [ ] 🚀 New Feature
Expand All @@ -11,9 +27,18 @@ Fixes / Relates to Issue: #
- [ ] Automated test suites pass locally.
- [ ] Changes verified manually in a local environment.

Manual verification run:
- `...`

Quality gates run:
- `...`

## Checklist
- [ ] My code adheres to the style guidelines of this repository.
- [ ] I have performed a thorough self-review of my changes.
- [ ] I have added inline comments in complex or critical logic blocks.
- [ ] My changes introduce no new lint errors or compiler warnings.
- [ ] I have added corresponding test coverage for new execution paths.

## Known Follow-up / Out of Scope
-
Loading