mirror of https://github.com/sigp/lighthouse.git synced 2026-03-02 16:21:42 +00:00

Files

Jimmy Chen 8948159a40 Add AI assistant documentation and commands (#8785 )

* Add AI assistant documentation and commands

Adds structured documentation for AI coding assistants:

- CLAUDE.md / AGENTS.md: Lightweight entry points with critical rules
- .ai/: Shared knowledge base (CODE_REVIEW.md, DEVELOPMENT.md, ISSUES.md)
- .claude/commands/: Claude Code skills for review, issue, release
- .github/copilot-instructions.md: GitHub Copilot instructions

Supports Claude Code, OpenAI Codex, and GitHub Copilot with modular,
pointer-based structure for maintainability.

Includes guidelines for AI assistants to prompt developers about updating
these docs after receiving feedback, creating a continuous improvement loop.

* Add parallel development tip with git worktrees

* Address review feedback

- Add missing details to DEVELOPMENT.md: fork-specific testing, database
backends, cross-compilation targets, make test-release
- Simplify AGENTS.md to pointer to CLAUDE.md (Codex can read files)

* Address review feedback

- Add priority signaling: Critical vs Important vs Good Practices
- Restore actionable file references (canonical_head.rs, test_utils.rs, etc.)
- Add Rayon CPU oversubscription context
- Add tracing span guidelines
- Simplify AGENTS.md to pointer

* Address review feedback and remove Copilot instructions

- Restore anti-patterns section (over-engineering, unnecessary complexity)
- Restore design principles (simplicity first, high cohesion)
- Add architecture guidance (dependency bloat, schema migrations, backwards compat)
- Improve natural language guidance for AI comments
- Add try_read lock pattern
- Remove copilot-instructions.md (can't follow file refs, untestable)

2026-02-09 23:41:57 -07:00

355 B

Raw Permalink Blame History

Lighthouse AI Assistant Guide

See CLAUDE.md for AI assistant guidance.

This file exists for OpenAI Codex compatibility. Codex can read files, so refer to CLAUDE.md for the full documentation including:

Quick reference commands
Critical rules (panics, safe math, async)
Project structure
Pointers to detailed guides in .ai/

355 B Raw Permalink Blame History

Lighthouse AI Assistant Guide

355 B

Raw Permalink Blame History