agentleFS
abiramcodesabiramcodes/angular-doctor/AGENTS.md

angular-doctor

AGENTS.md1 starsChanged 6 days agoMITView on GitHub

You are an expert in TypeScript, Angular, and scalable web application development. You write functional, maintainable, performant, and accessible code following Angular and TypeScript best practices. Use the skills in this repo when the user asks or the task clearly fits.

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

37 rules. About 0 are common, 16 are distinctive, and 21 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈16

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 21

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Do NOT verify visual or interactive work with headless Chrome, browser screenshots, --screenshot, CDP/Remote Debugging, or browser …

    line 5
  2. Very specific:

    Do NOT start any server (docs:dev, docs:preview, node …/index.mjs, ng serve, or similar) unless the user explicitly asks.

    line 6
  3. Distinctive:

    Verify with builds, typechecks, unit/integration tests, and non-browser CLI output only.

    line 7
  4. Distinctive:

    Use the skills in this repo when the user asks or the task clearly fits.

    line 12
  5. Distinctive:

    Out of scope: Do not apply caveman voice to persisted text (commits, PR bodies, generated docs) unless the user wants that.

    line 18
  6. Distinctive:

    What: Run a relentless interview: challenge assumptions, edge cases, failure modes, and missing requirements.

    line 23
  7. Very specific:

    angular-doctor: After Angular edits, follow skills/angular-doctor/SKILL.md (or run the CLI skill install).

    line 28
  8. Distinctive:

    Use strict type checking

    line 32
  9. Distinctive:

    Prefer type inference when the type is obvious

    line 33
  10. Very specific:

    Avoid the any type; use unknown when type is uncertain

    line 34
  11. Distinctive:

    Always use standalone components over NgModules

    line 38
  12. Very specific:

    Must NOT set standalone: true inside Angular decorators.

    line 39
  13. Very specific:

    Do NOT set changeDetection: ChangeDetectionStrategy.OnPush explicitly.

    line 40
  14. Distinctive:

    Use signals for state management

    line 41
  15. Very specific:

    Do NOT use the @HostBinding and @HostListener decorators.

    line 43
  16. Very specific:

    Use NgOptimizedImage for all static images.

    line 44
  17. Distinctive:

    Keep components small and focused on a single responsibility

    line 54
  18. Very specific:

    Use input() and output() functions instead of decorators

    line 55
  19. Very specific:

    Use model() for two-way bound properties with [(prop)] syntax instead of pairing input() with output()

    line 56
  20. Very specific:

    Use computed() for derived state

    line 57
  21. Very specific:

    Use linkedSignal() for state derived from multiple reactive sources that must stay synchronized

    line 58
  22. Distinctive:

    Prefer inline templates for small components

    line 59
  23. Very specific:

    Prefer Signal Forms (@angular/forms/signals) for new forms.

    line 60
  24. Distinctive:

    When not using Signal Forms, prefer Reactive forms instead of Template-driven ones

    line 61
  25. Very specific:

    Do NOT use ngClass, use class bindings instead

    line 62
  26. Very specific:

    Do NOT import CommonModule, import only the directives and pipes the template uses, such as AsyncPipe or DatePipe

    line 64
  27. Distinctive:

    When using external templates/styles, use paths relative to the component TS file.

    line 65
  28. Distinctive:

    Use signals for local component state

    line 69
  29. Distinctive:

    Keep state transformations pure and predictable

    line 71
  30. Very specific:

    Do NOT use mutate on signals, use update or set instead

    line 72
  31. Distinctive:

    Keep templates simple and avoid complex logic

    line 76
  32. Very specific:

    Use native control flow (@if, @for, @switch) instead of *ngIf, *ngFor, *ngSwitch

    line 77
  33. Distinctive:

    Use the async pipe to handle observables

    line 78
  34. Very specific:

    Do not assume globals like (new Date()) are available.

    line 79
  35. Very specific:

    Use the providedIn: 'root' option for singleton services

    line 84
  36. Very specific:

    Prefer the @Service decorator over @Injectable({providedIn: 'root'}) for new singleton services (Angular v22+)

    line 85
  37. Very specific:

    Use the inject() function instead of constructor injection

    line 86

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

You are an expert in TypeScript, Angular, and scalable web application development. You write functional, maintainable, performant, and accessible code following Angular and TypeScript best practices.

Verification Boundaries

  • Do NOT verify visual or interactive work with headless Chrome, browser screenshots, --screenshot, CDP/Remote Debugging, or browser automation unless the user explicitly asks for browser verification in that turn.
  • Do NOT start any server (docs:dev, docs:preview, node …/index.mjs, ng serve, or similar) unless the user explicitly asks. The user already runs the docs server for this repo and verifies manually.
  • Verify with builds, typechecks, unit/integration tests, and non-browser CLI output only. If a visual check the user asked for cannot run without a server, say so in one line instead of starting one.
  • These boundaries apply to all agent sessions in this repo (Muse, Claude Code, Codex, Cursor, and any other tool that reads this file). They stay until the user lifts them in-session.

Project agent skills

Use the skills in this repo when the user asks or the task clearly fits.

caveman (.agents/skills/caveman/SKILL.md)

  • When: The user says /caveman, "caveman mode", "be brief", "less tokens", or similar.
  • What: Terse, answer-first replies. Keep every technical fact, path, command, and code change exact. Stay in caveman voice until the user says "stop caveman" or "normal mode".
  • Out of scope: Do not apply caveman voice to persisted text (commits, PR bodies, generated docs) unless the user wants that.

grill-me (.agents/skills/grill-me/SKILL.md)

  • When: The user says /grill-me, "grill me", "interview this plan", or wants a design or plan stress-tested before implementation.
  • What: Run a relentless interview: challenge assumptions, edge cases, failure modes, and missing requirements. Do not start large implementation until the user confirms the sharpened plan (unless they say to proceed anyway).

Other skills

  • angular-developer: .agents/skills/angular-developer/SKILL.md is the source of truth for Angular conventions in this repo.
  • angular-doctor: After Angular edits, follow skills/angular-doctor/SKILL.md (or run the CLI skill install).

TypeScript Best Practices

  • Use strict type checking
  • Prefer type inference when the type is obvious
  • Avoid the any type; use unknown when type is uncertain

Angular Best Practices

  • Always use standalone components over NgModules
  • Must NOT set standalone: true inside Angular decorators. It's the default in Angular v20+.
  • Do NOT set changeDetection: ChangeDetectionStrategy.OnPush explicitly. OnPush is the default in Angular v22+.
  • Use signals for state management
  • Implement lazy loading for feature routes
  • Do NOT use the @HostBinding and @HostListener decorators. Put host bindings inside the host object of the @Component or @Directive decorator instead
  • Use NgOptimizedImage for all static images.
    • NgOptimizedImage does not work for inline base64 images.

Accessibility Requirements

  • It MUST pass all AXE checks.
  • It MUST follow all WCAG AA minimums, including focus management, color contrast, and ARIA attributes.

Components

  • Keep components small and focused on a single responsibility
  • Use input() and output() functions instead of decorators
  • Use model() for two-way bound properties with [(prop)] syntax instead of pairing input() with output()
  • Use computed() for derived state
  • Use linkedSignal() for state derived from multiple reactive sources that must stay synchronized
  • Prefer inline templates for small components
  • Prefer Signal Forms (@angular/forms/signals) for new forms. They are stable in Angular v22+ and provide signal-based state, type-safe field access, and schema-based validation
  • When not using Signal Forms, prefer Reactive forms instead of Template-driven ones
  • Do NOT use ngClass, use class bindings instead
  • Do NOT use ngStyle, use style bindings instead
  • Do NOT import CommonModule, import only the directives and pipes the template uses, such as AsyncPipe or DatePipe
  • When using external templates/styles, use paths relative to the component TS file.

State Management

  • Use signals for local component state
  • Use computed() for derived state
  • Keep state transformations pure and predictable
  • Do NOT use mutate on signals, use update or set instead

Templates

  • Keep templates simple and avoid complex logic
  • Use native control flow (@if, @for, @switch) instead of *ngIf, *ngFor, *ngSwitch
  • Use the async pipe to handle observables
  • Do not assume globals like (new Date()) are available.

Services

  • Design services around a single responsibility
  • Use the providedIn: 'root' option for singleton services
  • Prefer the @Service decorator over @Injectable({providedIn: 'root'}) for new singleton services (Angular v22+)
  • Use the inject() function instead of constructor injection

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.