Conversation
Summary of ChangesHello @liamnwhite1, I'm Gemini Code Assist1! 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 streamlines the development workflow by introducing a set of predefined pull request templates for different types of changes, such as bug fixes, new features, refactors, and general maintenance tasks. Additionally, it establishes clear code ownership for various sections of the repository, which will help in automating review assignments and clarifying responsibilities. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request introduces a set of standardized templates for pull requests and a CODEOWNERS file. The changes are well-structured and will help improve the consistency of PR submissions. I've left a few minor suggestions on the PR templates to improve their formatting and usability.
ab789e1 to
f9b882f
Compare
gknapp1
left a comment
There was a problem hiding this comment.
All of the documents are pretty much the same template, and they might be able to be merged into one document, per Sam's comment in the issue. But I understand the benefit from keeping them separate for automatic labeling. Given that these templates shouldn't be updated very frequently, I'm fine with leaving them separate from a maintenance standpoint.
fa3888a to
4fe8dc5
Compare
4fe8dc5 to
43daeed
Compare
- move attachment checklist to comments to avoid over-populating template (most of these would be N/A) - update the pull request type list to match CONTRIBUTING.md - add reference to pull request template in CONTRIBUTING.md
gknapp1
left a comment
There was a problem hiding this comment.
@liamnwhite1, I pushed some tweaks to the wording and moved some clutter in the attachment section to the comments, since most of the entries would be N/A for any given PR.
- moves most of the guidance to comments to reduce amount of irrelevant text shown in PR - combines a few sections to reduce difficulty of parsing information for reviewers
streeve
left a comment
There was a problem hiding this comment.
LGTM - I updated the PR description with the updated template.
On gitlab you can mark a checkbox as not applicable with a ~, but I guess not here..
647129e to
23ee124
Compare
23ee124 to
3b4f0a9
Compare
|
The changes you made look good to me. I made a few minor adjustments to formatting and indentation for consistency. I also uncommented the Attachments section and added a comment + checkbox (similar to Related issues) to indicate that it’s optional. My reasoning is that agents rely heavily on the hierarchical structure of Markdown. When the entire section is commented out, it effectively becomes nested under Testing strategy, which isn’t accurate and can make its intent ambiguous. This is admittedly a minor/defensive change, but it reduces the amount of interpretation required by the agent and lowers the risk of incorrect reasoning. If you feel strongly otherwise, I’m fine reverting it. |
If a commented optional section is potentially confusing to an agent, then I would prefer removing the attachments section completely as opposed to making it visible. After discussion with @streeve yesterday, it is somewhat ambiguous what the attachment section is for. Logs and figures should be included within the relevant sections if they are needed, not listed separately as an attachment. |
|
@gknapp1 Yeah that makes sense! The source of the section came from a different repo where it makes it more sense. I just removed the section though so if it's good, I can merge it! |
Summary
Add a repository pull request template that guides contributors to provide consistent context, testing details, validation evidence, and regression-risk notes when opening PRs.
Related issues
Details
This change adds a standardized pull request template for the repository so contributors can describe their changes in a consistent, review-friendly format.
The template is structured to support several PR categories, including bug fixes, features, performance work, refactors, and chores. It also prompts authors to document testing, validation evidence, attachments, and regression risk, which should make reviews easier and reduce back-and-forth on missing context.
Impact
This change adds documentation/workflow scaffolding only and does not modify application logic.
It improves the contributor workflow by making pull requests more consistent and by encouraging authors to include the information reviewers need to evaluate changes efficiently.
Testing strategy
The CI test suite covers this change.Manual testing performed for this change. If so, please describe.Notes: No code paths or runtime behavior were changed, so automated or workflow-based testing was not applicable for this commit.