.windsurf/rules/project.md
Windsurf rules for Spring Boot
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 Spring Boot project. This repository is a Spring Boot service. Controllers stay thin, transactions sit on the service the project already uses, and configuration comes from the environment.
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 Spring Boot with Maven or Gradle, whichever wrapper is in the repo. It does not assume WebFlux versus MVC, or a particular database. Follow the stack that is already on the classpath.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: project.md. Legacy path: .windsurfrules
# Windsurf rules
Rules for Windsurf Cascade in this Spring Boot repository.
If the project still uses a root `.windsurfrules` file, keep the same rules there.
## Stack
This repository is a Spring Boot service. Controllers stay thin, transactions sit on the service the project already uses, and configuration comes from the environment.
## Layout
- Controllers, services, and repositories follow the package split the project already has.
- DTOs are separate from JPA entities when the project already separates them.
- Configuration lives in application config and env vars. Do not hard-code a profile.
## Commands
- Test: `./mvnw test`
- Run: `./mvnw spring-boot:run`
- Package: `./mvnw package`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Validate request bodies with Bean Validation. Do not parse maps by hand.
- Keep `@Transactional` on the service boundary the project uses, not on the controller.
- Use constructor injection. Do not add field injection.
- Return the response type the controller already declares. Do not leak lazy entities.
- Match MVC or WebFlux. Do not block inside a reactive chain.
- Use the existing test slice: `@WebMvcTest`, `@DataJpaTest`, or `@SpringBootTest` only when you need the whole context.
## Testing
Add or update tests when behavior changes.
Add a sliced test for the controller or service. Do not boot the entire context for a validation rule.
## 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 exception handler for expected failures. A validation failure is 400, a missing row is 404.
## 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 catch Exception and return 200.
- Do not use the open-in-view pattern as an excuse to lazy-load in the controller.
- Do not commit `application-local` files that contain passwords.
- Do not add a new bean of a type that is already defined.
## Done when
- The requested behavior works.
- The module's tests pass. Use the Maven wrapper if it is present, otherwise the Gradle wrapper.
- 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 Windsurf rules on this page, or open the generator if you want different testing, strictness, or comment rules.
02
Save it at .windsurf/rules/project.md
Save it at `.windsurf/rules/project.md` in the Spring Boot repo. If the project still uses a single root file, save the same body as `.windsurfrules`.
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 Spring Boot agent often gets wrong, such as a request DTO with Bean Validation that returns 400 on a bad body. 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 Spring Boot repo?
Save it at `.windsurf/rules/project.md` in the Spring Boot 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 Spring Boot example assume?
The example assumes Spring Boot with Maven or Gradle, whichever wrapper is in the repo. It does not assume WebFlux versus MVC, or a particular database. Follow the stack that is already on the classpath.
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 Spring Boot
Windsurf rules for other stacks
- Windsurf rules for Next.js
- Windsurf rules for React
- Windsurf rules for Vue
- Windsurf rules for SvelteKit
- Windsurf rules for Node.js
- Windsurf rules for FastAPI
- Windsurf rules for Django
- Windsurf rules for Go
- Windsurf rules for Rust
- Windsurf rules for Unity
- Windsurf rules for Godot
- Windsurf rules for Laravel
- Windsurf rules for Rails
- Windsurf rules for Flutter
- Windsurf rules for Swift
- Windsurf rules for Kotlin
- Windsurf rules for Unreal
- Windsurf rules for Next.js + Supabase
- Windsurf rules for T3
- Windsurf rules for Astro
- Windsurf rules for Remix
- Windsurf rules for Nuxt
- Windsurf rules for Electron
- Windsurf rules for Tauri
- Windsurf rules for Expo
- Windsurf rules for .NET
- Windsurf rules for Phaser
- Windsurf rules for Bevy
- Windsurf rules for Roblox
- Windsurf rules for Python ML
- Windsurf rules for LangChain