docs: add pull request template for schema-first reviews

[brawlaphant]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @brawlaphant, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new pull request template to the repository. The primary goal is to enhance the efficiency and consistency of schema-first reviews by providing a structured format for authors to detail their changes, particularly concerning schema modifications. This will help reviewers quickly grasp the impact of changes and ensure all necessary information is provided upfront.

Highlights

• New Pull Request Template: A new pull request template has been added to the repository, specifically designed to facilitate schema-first reviews.
• Structured Review Process: The template includes sections for a 5-minute review summary, schema impact details (breaking/non-breaking changes, fields/enums changed, example JSON), changes by unit, and risk/rollback plans, aiming to standardize and streamline the review process.

Changelog

• .github/pull_request_template.md
  • Added a new pull request template to guide schema-first reviews.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new template for pull requests, focusing on schema-first reviews. The template is well-structured and covers important aspects like schema impact and validation. I've added a few suggestions to enhance the template's clarity and flexibility, particularly regarding how validation steps are listed, how JSON examples are displayed, and the naming of one of the sections. These changes should make the template even more effective for contributors.

[gemini-code-assist]

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)

[gemini-code-assist]

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

{}

[gemini-code-assist]

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
	-
	-
	-