Add some dos and don'ts to behavioral evals README.

[gundermanc]

Add best practices to README.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 documentation for behavioral evaluations by providing comprehensive best practices and a new guide for troubleshooting and fixing evaluations. Additionally, it improves the readability and conciseness of grep tool outputs for better LLM consumption and increases the content generation timeout for improved stability.

Highlights

• Behavioral Evals Documentation: The evals/README.md has been significantly updated to include best practices for designing behavioral evaluations and detailed instructions on how to fix failing evaluations using the new /fix-behavioral-eval command.
• Grep Tool Output Formatting: The output format for both the grep and ripGrep tools has been refined to be more concise and LLM-friendly. Line numbers are now grouped in the file header, and individual line prefixes have been removed, with '...' indicating non-consecutive matched lines.
• Content Generator Timeout: The HTTP timeout for the content generation process has been increased to 180 seconds to accommodate potentially longer generation times.

Changelog

• evals/README.md
  • Expanded the introductory description of behavioral evaluations to include their role in assessing feature reliability and preventing regressions.
  • Added a new 'Best Practices' section with guidelines for designing effective behavioral evals, covering aspects like realistic complexity, maintainable size, unambiguous assertions, 'fail first' principle, and preferring fewer, more realistic tests.
  • Introduced a comprehensive 'Fixing Evaluations' section, detailing the /fix-behavioral-eval command's functionality (Investigate, Fix, Verify, Report) and providing usage examples and manual debugging tips.
• packages/core/src/core/contentGenerator.ts
  • Increased the HTTP timeout for the GoogleGenAI client to 180000 milliseconds (3 minutes).
• packages/core/src/tools/grep.test.ts
  • Updated expected llmContent in various grep tool tests to reflect the new, more concise output format, removing individual 'L:' prefixes.
• packages/core/src/tools/grep.ts
  • Refactored the GrepToolInvocation to format grep results more concisely for LLM consumption, grouping matched line numbers in the file header and indicating non-consecutive lines with '...'.
• packages/core/src/tools/ripGrep.test.ts
  • Updated expected llmContent in various ripgrep tool tests to reflect the new, more concise output format, removing individual 'L:' prefixes.
• packages/core/src/tools/ripGrep.ts
  • Refactored the GrepToolInvocation (for ripgrep) to format results more concisely for LLM consumption, grouping matched line numbers in the file header and indicating non-consecutive lines with '...'.

Ignored Files

• Ignored by pattern: .gemini/** (1)
  • .gemini/commands/fix-behavioral-eval.toml

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]

Code Review

This pull request adds documentation for behavioral evals and refactors the output of the grep and ripGrep tools to be more readable. It also adds a timeout to API calls. My review focuses on a code duplication issue in the grep and ripGrep tools. The new formatting logic is identical in both files and should be extracted into a shared utility function to improve maintainability.

I am having trouble creating individual review comments. Click here to see my feedback.

packages/core/src/tools/grep.ts (259-276)

This block of code for formatting the grep results is duplicated in packages/core/src/tools/ripGrep.ts. To improve maintainability and avoid potential inconsistencies in the future, this logic should be extracted into a shared utility function. This function could take matchesByFile as an argument and return the formatted string.

packages/core/src/tools/ripGrep.ts (279-296)

This code block is a duplicate of the formatting logic found in packages/core/src/tools/grep.ts. As mentioned in the other comment, this should be refactored into a shared utility function to adhere to the DRY (Don't Repeat Yourself) principle.

[github-actions]

Size Change: -2 B (0%)

Total Size: 25.8 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	25.3 MB	-2 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js	221 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js	227 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js	11.5 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js	132 B	0 B
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B
./bundle/sandbox-macos-strict-open.sb	4.82 kB	0 B
./bundle/sandbox-macos-strict-proxied.sb	5.02 kB	0 B

_{compressed-size-action}

[abhipatel12]

LGTM