Skip to content

docs: add pull request template for schema-first reviews #29

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
brawlaphant wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add pull request template for schema-first reviews #29

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
37 changes: 37 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,37 @@
## Summary (5-minute review)
- Problem:
- What changed:
-
-
-
- Validation run:
- `npm run verify`
- `npm run check:index`
Comment on lines +7 to +9
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 24, 2026

Choose a reason for hiding this comment

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

medium

The Validation run section currently lists specific commands. To make the template more flexible and useful for various types of changes, consider using a checklist. This allows authors to indicate which standard checks were run and provides a place to add any other specific validation steps performed for the PR.

Suggested change
- Validation run:
- `npm run verify`
- `npm run check:index`
- Validation run:
- [ ] `npm run verify`
- [ ] `npm run check:index`
- [ ] (add any other validation steps taken)

- Result:

## Schema Impact (required)
- Schema files touched:
-
- Change type: `non-breaking` | `breaking`
- Fields/enums changed:
-
- Example JSON (before/after):

```json
{
"before": {},
"after": {}
}
```
Comment on lines +18 to +25
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 24, 2026

Choose a reason for hiding this comment

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

medium

For better readability, especially with complex schema changes, it's clearer to present the 'before' and 'after' JSON examples in separate code blocks. The current single-block format can make it difficult to compare the two states.

Suggested change
- Example JSON (before/after):
```json
{
"before": {},
"after": {}
}
```
- Example JSON:
**Before**
```json
{}

After

{}


## Changes by Unit
- Unit 1:
- Unit 2:
- Unit 3:
Comment on lines +27 to +30
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 24, 2026

Choose a reason for hiding this comment

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

medium

The section Changes by Unit is a bit ambiguous as 'Unit' is not defined. Renaming it to Implementation Details would make its purpose clearer to contributors, guiding them to provide a more detailed breakdown of the changes made.

Suggested change
## Changes by Unit
- Unit 1:
- Unit 2:
- Unit 3:
## Implementation Details
-
-
-


## Risk and Rollback
- Risks:
- Rollback plan:

## Out of Scope
-