Rails AI Rules: A Template for AI-Assisted Development

A comprehensive collection of rules, patterns, and standards designed to guide AI assistants in developing high-quality Ruby on Rails applications effectively.

Overview

This repository provides structured guidelines, best practices, and standard procedures to ensure consistent, maintainable, and robust code production when leveraging AI tools like Cursor and Cline for Rails development. It serves as a template and reference for teams aiming to standardize their AI-assisted workflows.

How Rules are Organized

This project distinguishes between different types of rules and documentation:

1. Generic System Prompt (generic.md):

   • This file contains fundamental behavioral instructions and operational modes (e.g., KEY_REQUIREMENTS, PLANNING_MODE, ARCHITECHTURE_MODE, DEBUG_MODE) for the AI assistant.
   • It sets the baseline for interaction style, code quality expectations, and specific workflows.
   • This can often be used as a base system prompt for the AI tool.

2. Generic Documentation (docs/):

   • Contains foundational project knowledge, architectural decisions, patterns, specifications, and workflows applicable regardless of the specific AI tool being used.
   • Files like docs/architecture.md, docs/patterns/, docs/specs/, docs/tdd.md, and docs/erd.mmd provide essential context for both human developers and AI assistants.
   • AI tools should be configured to reference these documents for background information and project standards, often directed by tool-specific rules.

3. Cursor-Specific Rules (.cursorrules, .cursor/rules/*.mdc):

   • These files are formatted specifically for use with the Cursor IDE.
   • They might contain rules leveraging Cursor's specific features or syntax (like .mdc files) and can reference both generic.md and files within docs/.
   • Refer to Cursor's documentation for how to integrate these rules effectively. The .cursorrules file is generally deprecated in favor of the .cursor/rules/ directory structure.

4. Cline-Specific Rules (.clinerules):

   • This file contains rules formatted for use with the Cline tool.
   • It defines project-specific instructions, preferences, and constraints directly consumable by Cline, potentially incorporating or referencing instructions from generic.md and context from docs/.

Integrating Rules with AI Tools

• System Prompt: Use the content of generic.md as a base system prompt if your AI tool supports it.
• Cursor: Place .mdc rule files within the .cursor/rules/ directory. These rules can instruct Cursor to adhere to generic.md principles and consult docs/.
• Cline: Ensure the .clinerules file is present. This file should incorporate the desired behaviors from generic.md and reference docs/ as needed.
• Generic Docs: Tool-specific rules (.clinerules, .mdc) should guide the AI on when and how to use the information within the docs/ directory.

Project Structure Overview

• README.md: This file - provides an overview and explains rule organization.
• generic.md: Base system prompt and behavioral instructions for the AI.
• .clinerules: Rules specifically for the Cline AI tool.
• .cursorrules / .cursor/rules/: Rules specifically for the Cursor IDE (prefer .cursor/rules/*.mdc).
• docs/: Generic project documentation (architecture, patterns, specs, TDD, ERD, decisions). Essential context for any AI or developer.
• LICENSE: Project license information.
• CONTRIBUTING.md: (Optional) Guidelines for contributing to this ruleset.

Key Concepts & Technologies

This ruleset assumes a modern Rails development stack. Key technologies and concepts are detailed within docs/architecture.md and relevant pattern/spec files. Examples include:

• Ruby on Rails (Version specified in docs/architecture.md)
• Hotwire (Turbo & Stimulus)
• ViewComponents
• TailwindCSS
• RSpec
• Service Objects
• Background Job Framework (Specified in docs/architecture.md)

Getting Started with This Template

1. Clone/Fork: Start with this repository as your base.
2. Customize generic.md: Adapt the base AI instructions to your team's preferences.
3. Customize docs/: Update generic documentation (architecture.md, erd.mmd, patterns, specs) to match your project.
4. Configure AI Rules:
   • Populate/modify .cursor/rules/ with .mdc files for Cursor, referencing generic.md and docs/.
   • Populate/modify .clinerules for Cline, incorporating generic.md principles and referencing docs/.
5. Integrate: Set up your AI tools to use the configured system prompts and rules.
6. Communicate: Ensure your team understands the structure and how to use/maintain the rules and documentation.

License

This project template is available as open source under the terms of the MIT License.