Home Original page

GitHub - copyleftdev/vibe-rules-collection: A curated collection of .windsurfrules files designed to guide AI coding assistants (like Codeium's Cascade) in generating code that adheres to various best practices, architectural patterns, language idioms, and framework conventions.

Surf smarter. Code smoother. Let the vibes guide you.

Vibey the Coding Surfer Dolphin

License: MIT Contributor Covenant

🌊 Overview

Vibe Rules Collection is a curated library of .windsurfrules files designed to guide AI coding assistants—especially Codeium's Cascade—to generate code that reflects best practices, idiomatic styles, and architectural clarity.

This repo provides a language- and framework-aware vibe system for smoother developer + AI collaboration.

📦 Contents

🎯 Purpose

AI tools accelerate development—but without vibes, they can generate code that’s noisy, offbeat, or even anti-patterned.

Enter Vibe Rules.

Each .windsurfrules file serves as a lightweight blueprint for:

  • Language idioms
  • Architectural paradigms
  • Design system consistency
  • DevOps conventions

Think of these files as surfboards: they help your AI ride the right wave.

🚀 Usage

  1. Clone or reference the relevant .windsurfrules files.
  2. Integrate with a compatible AI coding assistant (like Cascade in Windsurf IDE).
  3. Let your assistant vibe in style.

Configure your project to load rule files automatically or use them contextually via prompts.

📚 Rule Categories

API Design

  • graphql_api_design.windsurfrules
  • rest_api_design.windsurfrules

Architecture

  • Clean, Hexagonal, Microservices, MVC, SOA, etc.

Database

  • MySQL, PostgreSQL, SQL Server, Oracle PL/SQL, SQLite

Design Systems

  • Material, Apple HIG, Ant Design, Fluent UI, Atlassian

DevOps

  • Git workflows, Terraform, Shell, PowerShell

Financial

  • algorithmic_trading_principles.windsurfrules
  • alpaca_python_sdk.windsurfrules
  • backtesting_techniques.windsurfrules
  • financial_modeling_patterns.windsurfrules

Frameworks

  • Express, Flask, Rails, Unity, ASP.NET Core

Language Specific

  • Pythonic, Modern C++, Idiomatic Ruby, Modular TypeScript, Rust Clean Arch

MCP (Model Context Protocol)

  • anthropic_python_sdk_guidelines.windsurfrules

Paradigms

  • OOP, Functional, Event-Driven, Data-Oriented

Performance

  • General tuning & SQL optimization

Quality

  • Linting principles

Security

  • OWASP Top 10, Secrets Management, Input Validation

Testing

  • mutation_testing_principles.windsurfrules
  • hypothesis_property_based_testing.windsurfrules
  • contract_testing_pact.windsurfrules
  • performance_testing_principles.windsurfrules
  • chaos_engineering_principles.windsurfrules
  • accessibility_testing_a11y.windsurfrules
  • context_driven_testing_principles.windsurfrules
  • ui_page_object_model.windsurfrules
  • ui_screenplay_pattern.windsurfrules
  • ui_data_driven_testing.windsurfrules

🤝 Contributing

Pull requests are welcome. Got a vibe you want to share? Submit a .windsurfrules file or open a discussion.

See CONTRIBUTING.md for guidelines.

🌈 Code of Conduct

We vibe respectfully. All interactions are governed by the Code of Conduct.

📄 License

MIT License 2025 copyleftdev

See LICENSE for full terms.

🌀 Keep the code clean. Ride the right patterns. Respect the vibes. 🌀