Skip to content

feat: Make repo AI-ready with comprehensive guidelines - #1164

Closed
iammukeshm wants to merge 3 commits into
developfrom
feature/ai-ready
Closed

iammukeshm wants to merge 3 commits into
developfrom
feature/ai-ready

Conversation

@iammukeshm

Copy link
Copy Markdown
Member

🤖 AI-Ready FullStackHero

Makes the repository AI-assistant friendly so developers using Claude, Cursor, Copilot, or any AI can understand and follow the architectural patterns.

Files Added/Updated

File Purpose
CLAUDE.md Comprehensive guide for Claude Code / Claude AI
.cursorrules Rules for Cursor IDE
.github/copilot-instructions.md Instructions for GitHub Copilot

What's in CLAUDE.md

  • Philosophy — Why modular monolith + vertical slices
  • Mental Model — Visual architecture diagram
  • Decision Guide — "Where do I put this?" table
  • Code Patterns — Real examples with rationale
  • Critical Rules — The important constraints and WHY
  • Step-by-step — How to add features

Key Sections

Philosophy          → Architectural principles
Mental Model        → Visual layer diagram
The Vertical Slice  → Feature structure explained
Decision Guide      → Where to put what
Code Patterns       → Command, Handler, Endpoint, Validator
Critical Rules      → Mediator vs MediatR, DTOs, validation
Multi-Tenancy       → How it works automatically
Adding a Feature    → Step-by-step guide

Why This Matters

Developers using AI assistants will get correct guidance that follows FSH patterns:

  • AI understands to use Mediator not MediatR
  • AI knows DTOs go in Contracts projects
  • AI follows vertical slice structure
  • AI respects module boundaries

🤖 Built by Jarvis

jarvis added 3 commits January 25, 2026 13:19
- Rewrite CLAUDE.md with architectural philosophy and patterns
- Add .cursorrules for Cursor IDE users
- Add .github/copilot-instructions.md for GitHub Copilot

AI assistants can now understand:
- Modular monolith + vertical slice philosophy
- Feature structure and patterns
- Decision guides for where to put code
- Critical rules and rationale
Structure:
- CLAUDE.md → Entry point with quick reference
- .claude/rules.md → 12 hard constraints with rationale
- .claude/skills.md → Step-by-step guides for common tasks
- .claude/agents.md → AI behavior guidelines and decision framework

This enables AI assistants to:
- Understand architectural philosophy
- Follow patterns consistently
- Make correct decisions about code placement
- Catch common mistakes before they happen
@iammukeshm iammukeshm closed this Jan 25, 2026
@iammukeshm
iammukeshm deleted the feature/ai-ready branch May 27, 2026 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant