GEMINI.md
GEMINI.md for Rails
GEMINI.md is the project context file the Gemini CLI reads from the repository root. It should say how this codebase is built, tested, and reviewed so Gemini does not guess. This copy is written for a Rails project. This repository is a Ruby on Rails app. Follow the conventions already in the repo: MVC, migrations, and strong parameters. Do not introduce a second frontend stack.
The example uses a balanced, readable style, pragmatic tests, and comments only where the intent is not obvious. Open the generator to make the agent stricter, switch to test-first, quiet the comments, or pick a different file.
The example assumes a Rails app that uses migrations and Active Record. It does not assume Hotwire, React, or a particular auth gem. If the repo has chosen one, stay with it.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: GEMINI.md
# GEMINI.md
Project context for the Gemini CLI in this Rails repository. Read it before editing.
Other agents can follow the same rules, but Gemini loads this filename automatically.
## Stack
This repository is a Ruby on Rails app. Follow the conventions already in the repo: MVC, migrations, and strong parameters. Do not introduce a second frontend stack.
## Layout
- Controllers stay thin. Business rules live in models or plain objects the project already uses.
- Views and Turbo or Hotwire frames stay with the stack the app already renders.
- Schema changes are migrations. Do not edit `schema.rb` by hand.
## Commands
- Dev server: `bin/rails server`
- Tests: `bin/rails test`
- Migrate: `bin/rails db:migrate`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Use strong parameters. Do not pass `params` straight into `update`.
- Name files the way Zeitwerk expects. Do not fight the autoloader with a custom require.
- Add an index when you query a new column in a hot path.
- Use the existing test style, whether that is Minitest or RSpec.
- Keep credentials in the encrypted credentials store or the env. Do not commit secrets.
- Prefer framework generators' layout over a new folder taxonomy.
## Testing
Add or update tests when behavior changes.
Add a model or request test for the behavior you changed. Cover the forbidden parameter case.
## Style
- Optimize for the next reader over the shortest diff.
- Comment only when the why is non-obvious.
- Name things the way neighboring files already do.
- Do not reformat code you did not change.
## Errors
- Fail at the boundary. Do not swallow errors.
- Use model validations and a 4xx response for bad input. Unexpected errors belong in the Rails logger.
## Scope
- Do the requested task. Do not refactor unrelated code.
- Match the rigor already in the repo. Fix what you touch.
- Ask one clarifying question only when the task cannot be finished without it. Otherwise state the assumption and continue.
## Avoid
- Do not call `update_attribute` to skip validations unless the existing code does that for the same reason.
- Do not introduce callbacks that hide a side effect the caller cannot see.
- Do not query in a loop. Use `includes` when the view walks an association.
- Do not add a SPA framework to a Hotwire app without being asked.
## Done when
- The requested behavior works.
- `bin/rails test` passes, and `db:migrate` applies cleanly when the schema changed.
- The diff stays inside the task.
- You list anything you could not run.
Add it to the project
01
Copy a starting file
Copy the example GEMINI.md on this page, or open the generator if you want different testing, strictness, or comment rules.
02
Save it at GEMINI.md
Save it as `GEMINI.md` at the root of the Rails repo. Start a new Gemini CLI session so it picks up the file.
03
Start a fresh agent session
Rules files are read when a session starts. A chat that is already open may still be using the old instructions.
04
Give it one small task
Ask for one change a Rails agent often gets wrong, such as a controller action that permits only the intended parameters. If it ignores the file, confirm the path and start a new session.
Questions about this file
Where do I put GEMINI.md in a Rails repo?
Save it as `GEMINI.md` at the root of the Rails repo. Start a new Gemini CLI session so it picks up the file.
Which tools read this GEMINI.md?
The Gemini CLI reads GEMINI.md as project context. Claude Code reads CLAUDE.md instead, and most other agents read AGENTS.md.
What does the Rails example assume?
The example assumes a Rails app that uses migrations and Active Record. It does not assume Hotwire, React, or a particular auth gem. If the repo has chosen one, stay with it.
Does VibeSpell upload my repository?
No. Recipe pages are static, and the generator builds the file in your browser from the options you pick. Your source code never leaves the machine.
Other files for Rails
Cursor rules
.cursor/rules/project.mdc
AGENTS.md
AGENTS.md
CLAUDE.md
CLAUDE.md
system prompt
system-prompt.md
Copilot instructions
.github/copilot-instructions.md
Windsurf rules
.windsurf/rules/project.md
Cline rules
.clinerules
Cursor testing rule
.cursor/rules/testing.mdc
Cursor security rule
.cursor/rules/security.mdc
GEMINI.md for other stacks
- GEMINI.md for Next.js
- GEMINI.md for React
- GEMINI.md for Vue
- GEMINI.md for SvelteKit
- GEMINI.md for Node.js
- GEMINI.md for FastAPI
- GEMINI.md for Django
- GEMINI.md for Go
- GEMINI.md for Rust
- GEMINI.md for Unity
- GEMINI.md for Godot
- GEMINI.md for Laravel
- GEMINI.md for Flutter
- GEMINI.md for Swift
- GEMINI.md for Kotlin
- GEMINI.md for Unreal
- GEMINI.md for Next.js + Supabase
- GEMINI.md for T3
- GEMINI.md for Astro
- GEMINI.md for Remix
- GEMINI.md for Nuxt
- GEMINI.md for Electron
- GEMINI.md for Tauri
- GEMINI.md for Expo
- GEMINI.md for Spring Boot
- GEMINI.md for .NET
- GEMINI.md for Phaser
- GEMINI.md for Bevy
- GEMINI.md for Roblox
- GEMINI.md for Python ML
- GEMINI.md for LangChain