.windsurf/rules/project.md
Windsurf rules for Roblox
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 Roblox project. This repository is a Roblox experience in Luau. The server owns the truth. Clients request actions through remotes, and every remote validates its arguments.
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 Luau with the project's Rojo or Studio layout. It does not assume a particular framework such as Knit unless the repo already uses it.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: project.md. Legacy path: .windsurfrules
# Windsurf rules
Rules for Windsurf Cascade in this Roblox repository.
If the project still uses a root `.windsurfrules` file, keep the same rules there.
## Stack
This repository is a Roblox experience in Luau. The server owns the truth. Clients request actions through remotes, and every remote validates its arguments.
## Layout
- Server scripts live under ServerScriptService or the Rojo path that maps there.
- Client scripts live under StarterPlayer or the mapped client folder.
- Shared modules that both sides can require live in ReplicatedStorage. Secrets do not.
## Commands
- Serve: `rojo serve`
- Analyze: `Run the project's Luau analyzer, such as selene, if one is configured`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Use `--!strict` when the neighboring module is strict.
- The server decides currency, inventory, and combat results.
- Validate remote argument types and ranges before mutating state.
- Disconnect connections you create on instances that can be destroyed.
- Prefer the project's module style over a new framework.
- Name remotes for the action, not `RemoteEvent1`.
## Testing
Add or update tests when behavior changes.
Test pure module functions with the project's TestEZ or similar runner if it exists. Otherwise state the remote case you simulated.
## 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.
- Reject a bad remote with a warn that includes the player and the reason, then return. Do not kick for a single bad packet unless the project already does.
## 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 trust the client to say what item it received.
- Do not require a server-only module from a client script.
- Do not `wait()` in a loop. Use events or task.delay.
- Do not store unbounded player data on the instance without cleaning it up.
## Done when
- The requested behavior works.
- The server script rejects a wrong-typed remote argument, and the client path you changed still fires.
- 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 Roblox 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 Roblox agent often gets wrong, such as a remote that checks the player and the argument types on the server. 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 Roblox repo?
Save it at `.windsurf/rules/project.md` in the Roblox 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 Roblox example assume?
The example assumes Luau with the project's Rojo or Studio layout. It does not assume a particular framework such as Knit unless the repo already uses 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 Roblox
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 Spring Boot
- Windsurf rules for .NET
- Windsurf rules for Phaser
- Windsurf rules for Bevy
- Windsurf rules for Python ML
- Windsurf rules for LangChain