-
Notifications
You must be signed in to change notification settings - Fork 293
add styleguide for GCA code reviews #2366
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.
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
add styleguide for GCA code reviews #2366
Conversation
Note Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Quick review
|
||
**Example Structure**: | ||
```python | ||
@keras_hub_export("keras_hub.models.MyModelBackbone") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does GCA not read the repo at all, which is why we have to provide examples here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure - this is how they have provided their examples - https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a great question, @abheesht17! To clarify, I do analyze the code within the repository. However, providing explicit examples within a style guide like this is incredibly valuable for several reasons:
- Clarity and Precision: Examples help to unambiguously define the expected patterns and conventions, especially for nuanced or project-specific rules that might not be immediately obvious from general best practices.
- Consistency: They ensure that I, and any human reviewer, apply the rules consistently across the codebase.
- Customization: As @divyashreepathihalli pointed out with the link to the documentation, these examples are crucial for customizing my behavior. They serve as direct instructions on how to interpret and apply the style guide's principles to your specific project.
So, while I can read the repo, these examples act as a precise blueprint for how you want me to conduct reviews according to your team's standards.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh haha!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
No description provided.