# AGENTS.md

This file provides guidance to AI assistants when working with code in this repository.

...

## Coding Guidelines

### Development Rules

This project uses centralized development rules available at: @codegen/rules/RULES.md

Rules are automatically applied based on context and file types being worked on.

...

# Rules Index

This directory provides centralized development rules for any repository that includes these rules via symbolic link. Works with Claude Code and other AI assistants.

## Rule System Structure

Each rule file contains specific guidance for different aspects of development. Rules are organized by domain and responsibility:

- **@phoenix.md** - Phoenix framework development, LiveView, contexts, schemas, generators, PubSub, database operations
- **@elixir-code-generation.md** - Elixir code quality, specs, types, proper patterns, avoiding redundancy  
- **@elixir-readability.md** - Code formatting, sorting, pipe usage, variable naming, structure organization
- **@elixir-error-handling.md** - Error patterns, exception handling, validation approaches
- **@elixir-ci.md** - Testing, CI failures, code coverage, formatting issues, database test problems
- **@git.md** - Read-only git operations, viewing repository state, prohibited write operations
- **@planning.md** - Feature planning, development plans, documentation, project stages organization
- **@project-structure.md** - Directory organization, file naming, module placement conventions
- **@javascript-code-generation.md** - JavaScript/TypeScript patterns, LiveView hooks, frontend development
- **@i18n.md** - Internationalization patterns, gettext workflow, translation management
- **@github-workflows.md** - CI/CD patterns, GitHub Actions, deployment automation
- **@wallaby.md** - Browser testing, end-to-end testing, ChromeDriver usage
- **@npm-packages.md** - Package management, JavaScript dependencies in Phoenix projects
- **@comments.md** - Code documentation, when to add comments, documentation standards

## Usage Instructions

When working on code that matches the rule descriptions, apply the corresponding rule automatically. Rules are designed to be concise and actionable, focusing on specific development scenarios.

Unlike Cursor's .mdc format, these rules are integrated directly into the CLAUDE.md file context and activated based on relevance to the current task.

## Rule Integration

To use these rules in a project:

1. Set the environment variable: `export OCG_RULES_DIR=<path-to-rules-directory>`
2. Run `ocg setup` which will automatically create the symbolic link to `codegen/rules`
3. Reference this file from your project's CLAUDE.md with: `@codegen/rules/RULES.md`
4. Individual rules can be referenced as needed: `@codegen/rules/phoenix.md`, `@codegen/rules/elixir-code-generation.md`, etc.

Alternatively, you can manually create the symbolic link: `ln -s <rules_dir> codegen/rules`

This approach provides modular, reusable development guidance across all projects while maintaining project-specific customizations in the main CLAUDE.md file.

## Maintenance

Rules are maintained centrally in `<rules_dir>` and updated as development practices evolve. Changes automatically propagate to all projects using symbolic links.