Skip to content

Enhancement: Add AI context and helper files (GEMINI.md, AGENT.md, Copilot instructions) #85

@josephaw1022

Description

@josephaw1022

Description

To enhance the experience for developers using AI coding assistants (like Gemini, Claude, and GitHub Copilot), we should add specialized helper files/instructions to the repository. These files help agents understand the codebase architecture, coding standards, and project-specific contexts more effectively.

Proposed AI Helper Files

  • .gemini/ folder and .geminiignore
  • .gemini/settings: Configuration for rules, planning mode, and sub-agents.
  • .gemini/rules/: Project-specific rules.
  • .gemini/sub_agents/: Custom sub-agent definitions.
  • GEMINI.md: Documentation and context specifically for Google Gemini / Antigravity agents.
  • .cursorrules / AI.md: Instructions for Cursor/Claude-based agents.
  • .github/copilot-instructions.md: Custom instructions for GitHub Copilot.
  • AGENT.md: A general overview for any autonomous coding agent.
  • .vscode/mcp.json: MCP configurations for VS Code users.
  • .vscode/agents/: Agent definitions for VS Code users.

Information to Include

  • High-level architecture overview.
  • Key technologies (Go, Kubernetes Operator SDK, Helm).
  • Local development commands (task commands).
  • Coding conventions and PR requirements.
  • Links to existing documentation.

Expected Infrastructure Details

  • .gemini/settings:
    • Enable rules.
    • Enable planning mode (default).
    • Enable sub agents.
    • Include MCPs: Kubernetes (k8s) and SQL Server.
  • Rules: Add baseline project rules.
  • Sub Agents: Add initial sub-agent definitions.
  • VS Code:
    • mcp.json should mirror the MCPs in .gemini/settings.
    • agents/ should mirror the sub-agents in .gemini.

Why is this needed?

As AI-assisted coding becomes more prevalent, providing structured context (like "skills" or "instructions") ensures that agents produce higher-quality, project-compliant code and reduces the onboarding time for new contributors using these tools.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions