GEMINI.md
GEMINI.md for Rust
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 Rust project. This repository is a Rust crate on Cargo. Format with rustfmt, lint with cargo clippy, and use Result for recoverable failure.
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 Cargo crate, edition 2021 or newer. It does not assume a web framework or async runtime. Use thiserror or anyhow only when that crate is already a dependency.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: GEMINI.md
# GEMINI.md
Project context for the Gemini CLI in this Rust repository. Read it before editing.
Other agents can follow the same rules, but Gemini loads this filename automatically.
## Stack
This repository is a Rust crate on Cargo. Format with rustfmt, lint with cargo clippy, and use Result for recoverable failure.
## Layout
- Library code lives in `src/lib.rs` and modules under `src/`. Binaries live in `src/main.rs` or `src/bin/`.
- Integration tests live in `tests/`. Unit tests live in the module they cover.
- Keep `Cargo.toml` dependencies minimal. Do not add a crate the standard library already covers.
## Commands
- Test: `cargo test`
- Format: `cargo fmt`
- Lint: `cargo clippy --all-targets -- -D warnings`
- Build: `cargo build`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Run cargo fmt. Then run cargo clippy on non-trivial changes.
- Return `Result` for recoverable errors. `Option` is for absence, not for failure.
- Do not `unwrap` or `expect` in library paths. A binary may expect only when the failure is a programming bug.
- Do not clone your way out of the borrow checker without a one-line reason.
- Own data when the function stores it. Borrow when it only needs to look.
- Public items get a rustdoc comment when the comments setting asks for documentation.
## Testing
Add or update tests when behavior changes.
Add unit tests beside the function you changed. Cover the Ok path and one Err path.
## 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 the project's error type. If it has none, return `Result<T, impl std::error::Error>` only at the edge, and keep library errors typed.
## 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 use `unsafe` to pass a lint. Unsafe needs a safety comment the project already expects.
- Do not `.clone()` in a loop to silence a lifetime.
- Do not ignore a `Result` with `let _ =`.
- Do not add `#[allow]` for a clippy lint you can fix in a few lines.
## Done when
- The requested behavior works.
- `cargo test` passes. Run `cargo clippy --all-targets -- -D warnings` when the change is more than a comment.
- 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 Rust 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 Rust agent often gets wrong, such as a function that returns Result instead of unwrap on library input. 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 Rust repo?
Save it as `GEMINI.md` at the root of the Rust 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 Rust example assume?
The example assumes a Cargo crate, edition 2021 or newer. It does not assume a web framework or async runtime. Use thiserror or anyhow only when that crate is already a dependency.
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 Rust
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 Unity
- GEMINI.md for Godot
- GEMINI.md for Laravel
- GEMINI.md for Rails
- 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