CodeCompass

The Ultimate AI-Ready Coding Standards Library

Supercharge your development workflow with CodeCompass—a world-class, AI-optimized collection of coding standards, best practices, and architectural guidelines. Designed for seamless integration with next-generation coding assistants and developer platforms like windsurf.ai, cursor.ai, cline.bot, and more.

🚀 Why CodeCompass?

• AI-Native: Instantly empower your favorite AI coding tools with industry-proven rules and best practices.
• Universal: Covers every major language, framework, and workflow you need.
• Battle-Tested: Curated by experts, trusted by teams building tomorrow’s software.

---

📂 Complete File & Folder Structure

.codeiumignore
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
global_rules.md

architecture/
  adr_rules.md
  api_design_rules.md
  api_versioning_rules.md
  event_driven_architecture_rules.md
  general_architecture_rules.md
  kafka_rules.md
  microservices_rules.md
  serverless_architecture_rules.md

cloud/
  aws_rules.md
  azure_rules.md
  gcp_rules.md

databases/
  caching_rules.md
  database_schema_design_rules.md
  nosql_rules.md
  postgresql_rules.md
  supabase_rules.md

frameworks/
  angular_rules.md
  aspnetcore_rules.md
  cross_platform_mobile_rules.md
  django_rules.md
  expressjs_rules.md
  flutter_dart_rules.md
  rails_rules.md
  react_native_rules.md
  react_rules.md
  spring_boot_rules.md
  svelte_rules.md
  tailwind_rules.md
  vuejs_rules.md

languages/
  android_kotlin_rules.md
  csharp_dotnet_rules.md
  css_scss_rules.md
  go_rules.md
  ios_swift_rules.md
  java_rules.md
  javascript_typescript_rules.md
  nodejs_rules.md
  php_rules.md
  python_data_science_rules.md
  python_rules.md
  ruby_rules.md
  rust_rules.md

operations/
  chaos_engineering_rules.md
  cicd_rules.md
  docker_rules.md
  kubernetes_rules.md
  mlops_rules.md
  monitoring_logging_rules.md
  terraform_rules.md

security/
  penetration_testing_rules.md
  secrets_rotation_rules.md
  secure_defaults_rules.md
  security_rules.md
  threat_modeling_rules.md

testing/
  contract_testing_rules.md
  e2e_testing_rules.md
  performance_testing_rules.md
  testing_rules.md

workflow/
  code_comment_rules.md
  code_review_guidelines.md
  debugging_rules.md
  development_workflow_rules.md
  git_advanced_rules.md
  ide_configuration_rules.md
  linters_formatters_rules.md
  vite_rules.md
  webpack_rules.md

---

✨ How to Use CodeCompass

1. For AI Coding Assistants & Dev Tools

   • Import or reference the relevant markdown files in your AI coding assistant (e.g., windsurf.ai, cursor.ai, cline.bot).
   • Use as a knowledge base or rules engine for code generation, linting, or review.

2. For Teams & Individuals

   • Browse the folders for best practices tailored to your stack.
   • Copy, adapt, or enforce these guidelines in your projects.

3. Universal Principles

   • See global_rules.md for foundational rules that apply everywhere.

---

🏆 Core Principles

• Simplicity First – Choose the simplest practicable solution
• Readability Over Cleverness – Code must be immediately understandable
• Don’t Repeat Yourself – Avoid code duplication
• You Aren’t Gonna Need It – Implement only what’s requested
• Keep It Simple, Stupid – Prefer straightforward, maintainable solutions

---

🤝 Contributing

We love contributions! See CONTRIBUTING.md for how to help make CodeCompass even better.

📄 License

MIT — see LICENSE

🌟 Adopt CodeCompass Today

Unlock the full potential of your AI coding workflow. Make every line of code world-class.

The CodeCompass is guided by these core principles:

• Simplicity First - Choose the simplest practicable solution
• Readability Over Cleverness - Code must be immediately understandable
• Don't Repeat Yourself - Avoid code duplication
• You Aren't Gonna Need It - Implement only what's requested
• Keep It Simple, Stupid - Prefer straightforward, maintainable solutions

📜 Code of Conduct

Please review our Code of Conduct before participating in this project.