Skip to content

Conversation

@cboneti
Copy link
Member

@cboneti cboneti commented Nov 4, 2025

feat: Add Gemini Code Assist Customization

This PR introduces a customization for the Gemini Code Assist on GitHub to improve the quality and consistency of automated code reviews for the Cluster Toolkit.

By adding a .gemini/ directory with a styleguide.md and a default config.yaml, we provide Gemini with specific instructions and context about the Cluster Toolkit's best practices, structure, and documentation requirements.

The styleguide.md emphasizes:

  • Maintainability, Testing, and Documentation.
  • Blueprint Authoring best practices (e.g., use block, module sourcing).
  • Terraform Module Development guidelines.
  • Go Language standards.
  • Critical checks for updating index READMEs (modules/README.md, examples/README.md) when new modules/examples are added.
  • The importance of clear PR descriptions and test coverage.

This customization aims to make Gemini Code Assist reviews more relevant and helpful, catching potential issues early and reinforcing project conventions.

@cboneti cboneti force-pushed the feat/gemini-code-assist branch 2 times, most recently from 6768282 to e40a2ce Compare November 4, 2025 19:56
@cboneti
Copy link
Member Author

cboneti commented Nov 4, 2025

/gemini review

@gemini-code-assist
Copy link
Contributor

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

@cboneti cboneti force-pushed the feat/gemini-code-assist branch from e40a2ce to b577b32 Compare November 4, 2025 20:21
1. **Blueprint Authoring (YAML):**
* Ensure the `use` block is preferred for module dependencies within blueprints. Explicit variable linking (e.g., `setting = $(module.output)`) should only be used when necessary to resolve ambiguity.
* Verify that module sources are correct and the referenced modules exist.
* Check for logical grouping of modules within `deployment_groups`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should define the logical groupings based on module types eg) network, storage, cluster etc

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logical groups for deployment_groups is not defined. You have only added the folder definitions for modules here - 778c7a0#diff-2d64e32e0ed73fabd653270b96703ac45c54f710133a9ed5882c6d0c6efe6f32L24

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahh, I see. I am not sure how we should guide it at this point as I am not sure how we can guide an agent to find logical deployment groups...

@cboneti cboneti force-pushed the feat/gemini-code-assist branch from b577b32 to 70f22ce Compare November 5, 2025 16:35
Updates the Terraform module development guidelines to ensure
new modules are placed in the correct subdirectory within
`modules/` or `community/modules/.
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