This repository contains custom instruction files (.windsurfrules
) for Windsurf.
It's an optimized adaptation of cursorrules for Windsurf Cascade.
The configuration contains specifications for tech stacks, API version management, and project structures. Two versions are available:
- v1: A streamlined version with predefined settings
- v5: A fully configurable version with extensive customization options
Note: Testing has been conducted in specific environments and timeframes. Results may vary across different use cases and environments. Consider these .windsurfrules
as templates for your specific project requirements.
-
Place the
.windsurfrules
file in your project's root directory- Alternatively, paste the contents via [Windsurf - Settings] > [Set Workspace AI Rules] > [Edit Rules]
- For full configuration control: v5-en/.windsurfrules
- For standard implementation: v1-en/.windsurfrules
-
Customize the technical specifications in v5:
- Select the relevant part and press Cmd+i (or Ctrl+i) to open and edit.
- Without reference files, update rules using language/framework-specific best practices
- Update specifications as your project evolves
-
Custom instructions are most effective when combined with task-specific prompts and contextual reference materials.
- Effectiveness decreases if content conflicts with the Global AI Rules. Review the Global AI Rules thoroughly.
Released under the MIT License. See the LICENSE file for details.
This repository does not provide support services. For Windsurf Cascade updates, follow us on X: X (Twitter)