rules_template  by Bhartendu-Kumar

AI coding assistant template for enhanced performance in IDEs

Created 9 months ago
1,053 stars

Top 35.8% on SourcePulse

GitHubView on GitHub
Project Summary

This repository provides a universal template of rules for AI coding assistants like Cursor, CLINE, and RooCode. It aims to enhance AI-assisted development by integrating software engineering best practices and comprehensive documentation, benefiting both beginners and experienced developers seeking to improve AI output quality.

How It Works

The template structures AI interaction around a five-phase workflow: Requirements & Clarifications, Exhaustive Searching & Optimal Plan, User Validation, Implementation, and Further Suggestions. It leverages a persistent "memory" system using structured documentation files (PRDs, architecture, technical specs, task plans) to provide context and maintain project knowledge across AI sessions and different tools. Symbolic links ensure a single source of truth for rule files across supported platforms.

Quick Start & Requirements

  • Cursor: Place the .cursor/rules/ directory in your project root.
  • RooCode: Place the .roo/ directory in your project root.
  • CLINE: Place the .clinerules/ directory in your project root.
  • Note: These can be stacked simultaneously. Avoid copying the .git file.
  • Custom Modes: Advanced setup involves creating custom modes within Cursor and RooCode for token savings. Detailed instructions are provided for "Chat," "Write," and "MCP" modes.
  • Documentation: Cursor Setup, RooCode Setup, CLINE Setup

Highlighted Details

  • Token Efficiency: Incorporates newer modes in RooCode and Cursor designed for minimal token usage.
  • Agile Methodology: Rules are structured following Agile Development principles and software engineering best practices.
  • Automated Documentation: Prompts are designed to automatically update documentation after any planning, implementation, or debugging.
  • Cross-Platform: Natively respects guidelines for Cursor, CLINE, and RooCode, enabling consistent workflows across different AI assistants.

Maintenance & Community

  • The project is maintained by Bhartendu-Kumar. Further community links or roadmap details are not explicitly provided in the README.

Licensing & Compatibility

  • The README does not explicitly state a license. Compatibility is emphasized for Cursor, CLINE, and RooCode. Commercial use implications are not detailed.

Limitations & Caveats

  • CLINE has limited support for token-saving custom prompts. The README mentions a "To-Do" item to ignore files for unified system token saving, suggesting potential areas for improvement.
Health Check
Last Commit

5 months ago

Responsiveness

1 week

Pull Requests (30d)
0
Issues (30d)
1
Star History
9 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.