Skip to content
vibespell

.windsurf/rules/project.md

Windsurf rules for Go

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 Go project. This repository is a Go module. Format with gofmt, keep the standard library first, and pass context through exported I/O.

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 Go module that gofmt can format. It does not assume a web framework. If the repo uses chi, gin, or the standard net/http, stay with that router.

Customize in the generatorBrowse the library

Example file

Balanced strictness, readable style, pragmatic tests. Download name: project.md. Legacy path: .windsurfrules

# Windsurf rules

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

## Stack

This repository is a Go module. Format with gofmt, keep the standard library first, and pass context through exported I/O.

## Layout

- Packages are small and named for what they provide, not `util`.
- `cmd/` holds binaries. Importable code lives in other packages.
- Internal packages stay under `internal/` when the module already uses that boundary.

## Commands

- Test: `go test ./...`
- Format: `gofmt -w .`
- Vet: `go vet ./...`
- Build: `go build ./...`

Use the script the repo already defines when it differs from the command above.

## Conventions

- Run gofmt on every change. Do not hand-align code in a way gofmt will undo.
- Accept interfaces, return concrete types, unless the package already does otherwise.
- Pass `context.Context` as the first argument after the receiver on I/O that can be cancelled.
- Wrap errors with `%w` when the caller should use `errors.Is` or `errors.As`.
- Handle errors where they happen. Do not assign them to `_`.
- Exported names have a doc comment when the package is imported by other modules.

## Testing

Add or update tests when behavior changes.

Prefer table-driven tests in the same package. Cover the success path and one failure.

## 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.
- Return `error`. Wrap it with enough context to know which operation failed. Do not log and return the same error unless the caller cannot see the log.

## 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 panic for a normal error path.
- Do not start a goroutine without a way to finish it.
- Do not share a map across goroutines without synchronization.
- Do not add a framework for a handler the standard library already serves.

## Done when

- The requested behavior works.
- `gofmt` leaves the tree clean and `go test ./...` passes.
- 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 Go 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 Go agent often gets wrong, such as an exported function that takes context and returns a wrapped error. 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 Go repo?

Save it at `.windsurf/rules/project.md` in the Go 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 Go example assume?

The example assumes a Go module that gofmt can format. It does not assume a web framework. If the repo uses chi, gin, or the standard net/http, stay with that router.

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 Go

Windsurf rules for other stacks