Add more instructions for coding agents

[joshlf]

gherrit-pr-id: Icc2e26ad2a5c67a16f328a605b5821e36dbb343f

[gemini-code-assist]

Summary of Changes

Hello @joshlf, 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 significantly enhances the project's documentation, particularly for automated coding agents and human developers. It provides clearer, more comprehensive instructions for building, testing, linting, and validating changes across various Rust toolchains and features, aiming to streamline the development workflow and ensure consistency. Additionally, it improves code style guidelines and clarifies Cargo.toml configurations.

Highlights

• Documentation for AI/Coding Agents: The AGENTS.md file has been updated with a new title, 'Instructions to coding agents and AI code reviewers', and now includes more explicit guidance tailored for automated systems and developers.
• Enhanced Development Workflow Instructions: New and clarified instructions have been added for building, testing, and linting, emphasizing the use of the cargo.sh wrapper script and proper toolchain selection, especially for Clippy.
• Comprehensive Change Validation Guidelines: A new 'Validating changes' section provides detailed steps on how to ensure code compatibility across multiple Rust toolchains (MSRV, stable, nightly) and with different Cargo features, crucial for maintaining project stability.
• Improved Code Style and Formatting Rules: The documentation now includes specific guidelines for Markdown formatting, advocating for 80-column wrapping, and general improvements to line wrapping for better readability across the document.
• Clarification on Cargo.toml Configuration: An extensive comment has been added to Cargo.toml explaining the rationale behind the no-zerocopy-foo cfg naming convention, providing valuable context for future maintainers.

Ignored Files

• Ignored by pattern: .gemini/** (1)
  • .gemini/styleguide.md

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 enhances the AGENTS.md guide with more detailed instructions for building, testing, and validating changes, which is particularly helpful for coding agents and new contributors. It also clarifies the project's cfg naming strategy in Cargo.toml and improves formatting for readability. My review focuses on ensuring the new documentation guidelines are applied consistently within the document itself for better clarity and maintainability.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.33%. Comparing base (ce4e673) to head (ab45b91).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2834   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files          20       20           
  Lines        5794     5794           
=======================================
  Hits         5350     5350           
  Misses        444      444           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.