Windsurf
Windsurf is Codeium's AI-powered code editor. It uses project rules files to customize AI behavior.
Configuration File
.windsurfrulesA plain text or markdown file that Windsurf reads to understand your project preferences.
File Location
your-project/ ├── .windsurfrules ← Your config file goes here ├── src/ └── package.json
Place the file in your project root directory.
How Windsurf Uses It
Windsurf's Cascade feature reads your rules file to:
- Understand your project context
- Generate code matching your style
- Follow your specified conventions
- Provide more relevant suggestions
Example Rules File
# Project Rules ## Project Overview Full-stack e-commerce application ## Tech Stack - Frontend: Vue 3 with Composition API - Backend: Python FastAPI - Database: PostgreSQL - Cache: Redis ## Code Guidelines ### Frontend - Use TypeScript for all Vue components - Prefer <script setup> syntax - Use Pinia for state management - Follow Vue style guide ### Backend - Use Pydantic models for validation - Type hints on all functions - Async endpoints where beneficial - SQLAlchemy ORM for database ## Git Conventions - Conventional commits - Feature branches from main - Squash merge for PRs
Tips
Structure with Headers
Use markdown headers to organize rules by topic.
Separate Frontend/Backend
For full-stack projects, clearly separate rules for each part.
Include Examples
Show code snippets demonstrating your preferred patterns.
Keep Updated
Update rules as your project evolves and conventions change.