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 introduces a new documentation file, AGENTS.md, which serves as a detailed guide for AI coding agents interacting with the COLMAP project. It aims to streamline the onboarding process for automated tools by providing a structured overview of the codebase, its components, and operational procedures. Additionally, minor adjustments were made to the .gitignore file to improve build artifact exclusion and Python version management.
Highlights
- New AGENTS.md file: A new
AGENTS.mdfile has been added to provide comprehensive context for coding agents, detailing the project's overview, architecture, build instructions, and more. - .gitignore updates: The
.gitignorefile was updated to include.python-versionfor Python environment management and to generalize the ignored installation directories frominstall-debug/andinstall-release/to a singleinstall*/entry.
- .gitignore
- Added
.python-versionto ignore local Python version files. - Generalized
install-debug/andinstall-release/toinstall*/for broader exclusion of build output directories.
- Added
- AGENTS.md
- Added a new Markdown file providing a comprehensive guide for coding agents.
- Included sections on project overview, directory structure, module dependency layers, key classes and files, build instructions, testing procedures, code style conventions, and external dependencies.
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
-
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. ↩