Skip to content

docs: Add PR guidelines in 'CONTRIBUTING.md'#2304

Merged
duwenxin99 merged 5 commits into
mainfrom
guide
Jan 14, 2026
Merged

docs: Add PR guidelines in 'CONTRIBUTING.md'#2304
duwenxin99 merged 5 commits into
mainfrom
guide

Conversation

@duwenxin99

@duwenxin99 duwenxin99 commented Jan 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Add PR guidelines - some best practices

@duwenxin99 duwenxin99 requested a review from a team January 13, 2026 22:22
@gemini-code-assist

gemini-code-assist Bot commented Jan 13, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @duwenxin99, 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 introduces a new set of guidelines within the CONTRIBUTING.md file, aiming to standardize and improve the quality of contributions. The added instructions focus on maintaining manageable pull request sizes, ensuring robust testing, and providing clear documentation for changes, thereby streamlining the review process and enhancing overall project maintainability.

Highlights

  • New PR Guidelines Section: A new section titled "Guidelines for Pull Requests" has been added to CONTRIBUTING.md, providing clear instructions for contributors.
  • Emphasis on Small PRs: The guidelines now explicitly recommend keeping pull requests small for easier review, updates, and rollbacks, with a specific note for contributions involving new database sources or tools.
  • Enhanced Testing Requirements: Contributors are reminded to ensure thorough unit and integration testing, and to add additional tests for tools not covered by predefined tests.
  • Best Practices for Contributions: The new guidelines cover best practices such as opening issues for non-trivial changes and providing comprehensive PR descriptions.

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

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[bot]
gemini-code-assist Bot reviewed Jan 13, 2026
View reviewed changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds valuable guidelines for contributors to CONTRIBUTING.md, which will help maintain code quality and streamline the review process. The new sections on pull request size, discussing changes, writing good descriptions, and testing are all excellent additions. My review includes a few minor suggestions to fix typos and improve grammar for better clarity in the documentation.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Yuan325
Yuan325 reviewed Jan 14, 2026
View reviewed changes
Comment thread CONTRIBUTING.md Outdated
@duwenxin99 duwenxin99 enabled auto-merge (squash) January 14, 2026 18:47
@duwenxin99 duwenxin99 merged commit 2817dd1 into main Jan 14, 2026
12 checks passed
@duwenxin99 duwenxin99 deleted the guide branch January 14, 2026 19:08
the-ericwang35 pushed a commit to the-ericwang35/genai-toolbox that referenced this pull request Jan 15, 2026
@duwenxin99 @the-ericwang35
docs: Add PR guidelines in 'CONTRIBUTING.md' (googleapis#2304)
9acd38b 
Add PR guidelines - some best practices
mahlevanshika pushed a commit to mahlevanshika/genai-toolbox that referenced this pull request Jan 22, 2026
@duwenxin99 @mahlevanshika
docs: Add PR guidelines in 'CONTRIBUTING.md' (googleapis#2304)
0cda164 
Add PR guidelines - some best practices
kshalu-code pushed a commit to kshalu-code/genai-toolbox that referenced this pull request Feb 4, 2026
@duwenxin99 @kshalu-code
docs: Add PR guidelines in 'CONTRIBUTING.md' (googleapis#2304)
28d0fde 
Add PR guidelines - some best practices
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Yuan325 Yuan325 Yuan325 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@Yuan325 Yuan325

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@duwenxin99 @Yuan325