refactor(docs): Refactor GEMINI.md file

[sokoliva]

Changes

• add AGENTS.md file

• add docs/ai/coding_conventions.md file

• add docs/mandatory_checks.md file

• refactor GEMINI.md

• Follow the CONTRIBUTING Guide.

• Make your Pull Request title in the https://www.conventionalcommits.org/ specification.

  • Important Prefixes for release-please:
    • fix: which represents bug fixes, and correlates to a SemVer patch.
    • feat: represents a new feature, and correlates to a SemVer minor.
    • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

• Ensure the tests and linter pass (Run bash scripts/format.sh from the repository root to format)

• Appropriate docs were updated (if necessary)

[gemini-code-assist]

Summary of Changes

Hello, 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 aims to enhance the project's documentation structure, particularly for AI-driven development workflows. It introduces dedicated files for coding conventions and mandatory checks, and refactors the main GEMINI.md guide to integrate these new resources, providing a more organized and comprehensive set of instructions for contributors.

Highlights

• New Documentation Files: Added AGENTS.md, docs/ai/coding_conventions.md, and docs/ai/mandatory_checks.md to centralize and organize project guidelines, particularly for AI-driven development workflows.
• GEMINI.md Refactor: The GEMINI.md file was significantly restructured to provide a clearer overview of the project, technology stack, and mandatory AI workflow, now referencing the newly created documentation files for detailed guidelines.

Changelog

• AGENTS.md
  • Added a new file to serve as a compatibility placeholder, directing users to GEMINI.md for full instructions.
• GEMINI.md
  • Rewrote the entire document to introduce an 'Agent Command Center' structure.
  • Added sections for 'Project Overview & Purpose', 'Technology Stack & Architecture', 'Style Guidelines & Mandatory Checks', and 'Mandatory AI Workflow for Coding Tasks'.
  • Updated references to point to the new docs/ai/coding_conventions.md and docs/ai/mandatory_checks.md files.
  • Removed previous sections on project frameworks and code style/mandatory checks, as these are now detailed in external files.
• docs/ai/coding_conventions.md
  • Added a new file detailing non-negotiable coding conventions and style guidelines, including Python types, type safety, formatting, and linting rules.
• docs/ai/mandatory_checks.md
  • Added a new file outlining the exact shell commands for running formatting, linting, type checking, testing, and coverage checks.

Activity

• No human activity has been recorded on this pull request yet.

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 refactors the documentation for AI agents by restructuring GEMINI.md and moving content into new, more focused files: docs/ai/coding_conventions.md and docs/ai/mandatory_checks.md. The changes significantly improve the clarity and organization of the instructions. I've added a couple of minor suggestions to further enhance consistency and clarity in the documentation.

[github-actions]

🧪 Code Coverage (vs main)

⬇️ Download Full Report

No coverage changes.

Generated by coverage-comment.yml