Skip to content
Prompt

vibecoding — Windsurf Rules

by PaulDuvall

AI Summary

Windsurf Rules is a project-specific ruleset for AI-powered development automation in Windsurf IDE, providing task tracking and documentation standards to maintain consistency across repositories. Developers and teams using Windsurf will benefit from standardized workflows and persistent memory structures.

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "vibecoding — Windsurf Rules" prompt rules to my project.
Repository: https://github.com/PaulDuvall/vibecoding

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

Windsurf Vibe Coding: AI-powered development workflow automation with persistent memories and rule-based standards

Project-Specific Rules: .windsurfrules.md

This file documents project-specific rules, exceptions, and implementation details for this repository. For organization-wide standards, see global_rules.md.

1.1. Task Tracking

• All project tasks must be recorded in tasks.md using a clear, unique identifier (e.g., TASK-001). The Windsurf AI IDE should provide tools for easy creation and management of these tasks. • Each task entry must include: • Task ID and a concise, descriptive title. • Detailed description of the task. • Assignee: The person or team responsible (e.g., @username or "AI Cascade"). • Status: One of [Open, In Progress, Blocked, Complete], with a status icon placed in the same cell as the status (e.g., 🟢 Open, ✅ Complete). • Status Icons: • 🟢 Open • 🟡 In Progress • 🔴 Blocked • ✅ Complete • Link(s) to related user stories (e.g., in docs/user_stories.md), implementation files, and test files. The IDE should facilitate creating these links. • Date created and last updated (use ISO 8601 format: YYYY-MM-DD). • (Optional) Estimated effort and actual effort (e.g., in hours or story points). • When a new task is created, it must be appended to tasks.md with status 🟢 Open. The Windsurf AI IDE may offer views to sort/filter tasks by priority, status, or assignee. • Status must be updated as work progresses. If a task is 🔴 Blocked, the reason must be documented clearly in the task description or a dedicated "Blocker Reason" field. • For tasks spanning multiple codebases or repositories, provide cross-repo traceability links and document any special handling in the task entry.

2. Documentation Standards

• For comprehensive IAM role and policy authoring, review, and least-privilege best practices, see .iamrolerules.md. • All contributors must follow the IAM role and policy authoring, review, and least-privilege best practices defined in .iamrolerules.md, as well as the organization-wide CI/CD and automation best practices defined in .cicdrules.md.

2.1. General Documentation (`docs/` Folder)

• All supporting documentation (except this .windsurfrules.md file) must be stored as markdown (.md) files in the docs/ directory at the project root. • Each markdown file in docs/ should cover a specific topic. Recommended standard filenames include: • architecture.md • security_practices.md • user_stories.md • development_workflow.md • onboarding.md • traceability_matrix.md • process_exceptions.md • A README.md within the docs/ folder itself is recommended if the documentation structure becomes complex, explaining the purpose of key documents. • All code refactoring must follow the canonical rules and patterns defined in .refactoringrules.md, which is based on Martin Fowler’s Refactoring Catalog and tailored for this project. • Documentation files must be kept up to date as the project evolves. Changes to documentation should be part of the regular review process. The Windsurf AI IDE may prompt for documentation updates when related code changes are detected. • All documentation and diagrams must be accessible (e.g., include alt text for images/diagrams, use readable tables). • When creating architecture or other diagrams, always use Mermaid syntax for diagram blocks in markdown files (e.g., `mermaid ... ` ). The IDE should offer a preview for Mermaid diagrams.

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 7mo ago
Stale
AdoptionUnder 100 stars
12 ★ · Niche
DocsREADME + description
Well-documented

GitHub Signals

Stars12
Forks1
Issues0
Updated7mo ago
View on GitHub
MIT License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more