Skip to content

docs: update contribution guide, GEMINI.md, and llm.txt#743

Merged
eliasecchig merged 1 commit intomainfrom
docs/contribution-guide
Feb 2, 2026
Merged

docs: update contribution guide, GEMINI.md, and llm.txt#743
eliasecchig merged 1 commit intomainfrom
docs/contribution-guide

Conversation

@allen-stephen
Copy link
Collaborator

Summary

  • Add Language-Specific Notes section to both CONTRIBUTING.md and GEMINI.md
  • Update directory references to be scalable for future languages
  • Add Go template testing examples to GEMINI.md

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @allen-stephen, 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 focuses on a major overhaul of the project's contribution guidelines and AI agent documentation. The changes aim to streamline the onboarding process for new contributors and provide explicit, structured instructions for developing and testing templates within the Agent Starter Pack. By detailing architectural layers, templating rules, and a robust testing workflow, the PR ensures that future modifications are consistent, scalable, and less prone to errors, ultimately improving the maintainability and extensibility of the project.

Highlights

  • Documentation Restructuring: The CONTRIBUTING.md and GEMINI.md files have been significantly restructured and expanded to provide clearer guidance for both human contributors and AI coding agents.
  • Language-Specific Notes: New sections for language-specific notes have been added to CONTRIBUTING.md and GEMINI.md, including details for Python, Go, Java, and TypeScript, enhancing scalability for future language support.
  • Template Development Workflow: A detailed, step-by-step template development workflow has been introduced in CONTRIBUTING.md and GEMINI.md, outlining the process for modifying Jinja templates, including testing and backporting changes.
  • Enhanced Testing Strategy: The GEMINI.md file now includes a comprehensive testing strategy for template changes, emphasizing cross-combination testing across different agents, deployments, and features to ensure robustness.
  • Directory Reference Updates: Directory references have been updated to be more scalable and language-agnostic, moving from a generic base_template to base_templates/<language>/.
  • Go Template Testing Examples: Specific examples for Go template testing have been added to GEMINI.md, providing practical guidance for contributors working with Go-based agents.
  • Clarified llm.txt Scope: The llm.txt file has been updated to explicitly define its scope as guidance for AI agents working with generated projects, clearly distinguishing it from the contribution guide for the repository itself.
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 provides a significant overhaul of the project's contribution documentation, including CONTRIBUTING.md, GEMINI.md, and llm.txt. The changes are excellent, introducing a clearer structure, more detailed development and testing workflows, and better-defined scopes for each guide. The updates to use the scalable base_templates directory and the addition of Go-specific examples are also valuable. I've identified one minor inconsistency in GEMINI.md for your consideration. Overall, these changes greatly improve the developer experience and are a welcome addition.

@eliasecchig eliasecchig merged commit bf32b84 into main Feb 2, 2026
36 checks passed
enriquekalven pushed a commit to enriquekalven/agent-starter-pack that referenced this pull request Feb 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants