rulebook-ai  by botingw

Universal rules template for AI coding assistants

Created 5 months ago
345 stars

Top 80.2% on SourcePulse

GitHubView on GitHub
Project Summary

This repository provides a universal template for AI coding assistant rules, aiming to standardize behavior and enforce best practices across platforms like GitHub Copilot, Cursor, CLINE, Roo Code, and Windsurf. It targets developers working on complex projects or teams using multiple AI assistants, offering a structured "memory bank" for persistent project context and consistent AI-driven development workflows.

How It Works

The template centralizes AI interaction rules and project documentation into a unified system. It defines structured workflows for planning, implementation, and debugging, inspired by software engineering principles. A "memory bank" comprising organized documentation files (PRDs, architecture, technical specs, task lists) provides deep, persistent context to AI assistants, reducing repetitive explanations and improving code quality.

Quick Start & Requirements

  • Install rules into your project: python src/manage_rules.py install <path_to_your_target_repo> [--rule-set <rule_set_name>]
  • Requires Python 3.11+ for environment setup.
  • Dependencies managed via requirements.txt.
  • Playwright needs to be installed: playwright install.
  • Setup involves cloning the repo and running Python scripts.

Highlighted Details

  • Cross-platform compatibility with Cursor, CLINE, Roo Code, Windsurf, and GitHub Copilot.
  • Structured "Memory Bank" for persistent project context (docs/, tasks/).
  • Enforces software engineering best practices via rule files (plan.md, implement.md, debug.md).
  • Managed via Python scripts (manage_rules.py) for installation, synchronization, and cleanup.
  • Supports customization of rules and memory within the target project.

Maintenance & Community

  • Primarily maintained by botingw.
  • Community feedback via GitHub Issues.
  • Anonymous feedback via a provided Google Form.

Licensing & Compatibility

  • The repository itself appears to be under an unspecified license, but the README does not explicitly state a license for the template's code or content. Further clarification on licensing is recommended for commercial use.

Limitations & Caveats

  • The README mentions a "To-Do #1" regarding the correct structure for RooCode, indicating potential incomplete implementation for that specific platform.
  • The license is not explicitly stated, which could be a concern for commercial adoption or integration into closed-source projects.
Health Check
Last Commit

5 days ago

Responsiveness

Inactive

Pull Requests (30d)
30
Issues (30d)
11
Star History
47 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.