Skip to content
vibespell

.windsurf/rules/project.md

Windsurf rules for Rust

Windsurf rules tell the Cascade agent how this repo is built and tested. The current location is `.windsurf/rules`. Older setups still read a root `.windsurfrules` file. 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: project.md. Legacy path: .windsurfrules

# Windsurf rules

Rules for Windsurf Cascade in this Rust repository.
If the project still uses a root `.windsurfrules` file, keep the same rules there.

## 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

  1. 01

    Copy a starting file

    Copy the example Windsurf rules on this page, or open the generator if you want different testing, strictness, or comment rules.

  2. 02

    Save it at .windsurf/rules/project.md

    Save it at `.windsurf/rules/project.md` in the Rust repo. If the project still uses a single root file, save the same body as `.windsurfrules`.

  3. 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.

  4. 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 Windsurf rules in a Rust repo?

Save it at `.windsurf/rules/project.md` in the Rust repo. If the project still uses a single root file, save the same body as `.windsurfrules`.

Which tools read this Windsurf rules?

Windsurf reads `.windsurf/rules/*.md` and, on older projects, `.windsurfrules`. Cursor and Claude Code do not load this path.

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

Windsurf rules for other stacks