Skip to content

Update Playbook - #114

Open
gcatanese wants to merge 4 commits into
mainfrom
update-playbook
Open

Update Playbook#114
gcatanese wants to merge 4 commits into
mainfrom
update-playbook

Conversation

@gcatanese

Copy link
Copy Markdown
Contributor

Updated the Playbook to clarify the engineer's workflows and include some notes/tips for using the tool

@gcatanese
gcatanese requested review from a team as code owners March 19, 2026 16:11
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, 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 significantly enhances the Playbook.md documentation by clarifying and expanding the engineer's workflows for SDK development. It introduces practical tips and detailed scenarios, making the guide more comprehensive and user-friendly for tasks ranging from fixing code generation to adding new API features or services. The changes aim to streamline the development process and improve the overall understanding of the SDK automation tool's usage.

Highlights

  • Enhanced Workflow Clarity: The 'Engineer's Workflow' section has been completely restructured and expanded to detail four distinct scenarios, providing clearer guidance for various development tasks.
  • New Pro Tips and Best Practices: Several new 'Pro tips' have been added throughout the document, offering practical advice on topics like symlinking, schema management, and generating all services, improving efficiency and understanding.
  • Updated Code Generation Details: The description of the code generation process has been revised to clarify steps, including how OpenAPI specs are handled, where generated code is output, and how it's copied.

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

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 gemini-code-assist Bot left a comment

Copy link
Copy Markdown

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 updates the engineering playbook to clarify workflows and add helpful tips. While the additions are valuable, there are several small issues such as typos, formatting errors, a broken link, and incorrect code examples. I've provided specific comments and suggestions to address these points. Correcting them will improve the overall quality and usability of the documentation.

Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
Comment thread Playbook.md Outdated
@gcatanese
gcatanese requested a review from thomasc-adyen March 25, 2026 09:41
@gcatanese
gcatanese enabled auto-merge March 30, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants