2 KiB
2 KiB
GEMINI.md Template
A flexible template for creating global rules. Adapt sections based on your project type.
GEMINI.md
This file provides guidance to Gemini when working with code in this repository.
Project Overview
{Project description and purpose}
Tech Stack
| Technology | Purpose |
|---|---|
| {tech} | {why it's used} |
Commands
# Development
{dev-command}
# Build
{build-command}
# Test
{test-command}
# Lint
{lint-command}
Project Structure
{root}/
├── {dir}/ # {description}
├── {dir}/ # {description}
└── {dir}/ # {description}
Architecture
{Describe the architectural approach and data flow}
Code Patterns
Naming Conventions
- {convention}
File Organization
- {pattern}
Error Handling
- {approach}
Testing
- Run tests:
{test-command} - Test location:
{test-directory} - Pattern: {describe test approach}
Validation
{validation-commands}
Key Files
| File | Purpose |
|---|---|
{path} |
{description} |
On-Demand Context
| Topic | File |
|---|---|
| {topic} | {path} |
Notes
- {note}