-
Notifications
You must be signed in to change notification settings - Fork 36
doc: add separate error test guidance #3475
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
Conversation
Summary of ChangesHello @noahdietz, 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 enhances the Go style guide documentation by introducing a dedicated section on best practices for writing error tests. The changes aim to improve the clarity, maintainability, and robustness of test suites by advocating for the separation of error and functional tests, specific naming conventions, and proper error comparison techniques. 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. 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.
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 documentation for writing separate error tests in Go. The new section is a good addition to the guide. However, the provided Go code example contains several syntax errors that would prevent it from compiling. I've provided a corrected version of the code snippet that fixes these errors and also aligns with the existing guidance in the document for using t.Run in table-driven tests.
|
/gemini review |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3475 +/- ##
=======================================
Coverage 81.05% 81.05%
=======================================
Files 166 166
Lines 13817 13823 +6
=======================================
+ Hits 11199 11204 +5
- Misses 2032 2035 +3
+ Partials 586 584 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Code Review
This pull request adds valuable guidance to howwewritego.md on separating error tests from functional tests. The explanation and example are clear and follow the linked Google style guide. I've suggested a few minor improvements to the code example for better formatting consistency and more informative test failure messages, as well as a small fix for a trailing space in the markdown.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Noah Dietz <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Noah Dietz <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Noah Dietz <[email protected]>
Add simple guidance for separating error tests from functional tests based on https://google.github.io/styleguide/go/decisions.html#table-driven-tests and http://go/gotip/episodes/50.