mirror of https://github.com/sigp/lighthouse.git synced 2026-03-22 06:14:38 +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

1.3 KiB

Raw Blame History

GitHub Issue Creation Task

You are creating a GitHub issue for the Lighthouse project.

Required Reading

Before creating an issue, read .ai/ISSUES.md for issue and PR writing guidelines.

Structure

Description (required)
- First paragraph: problem and brief solution
- Context about current behavior
- Links to related issues, PRs, or specs
- Technical and specific
Steps to Resolve (when applicable)
- Present options and considerations
- Don't be overly prescriptive
- Mention relevant constraints
Code References
- Use GitHub permalinks with commit hashes
- Get hash: git rev-parse unstable

Style

Natural, concise, direct
Avoid AI-sounding language
Be honest about uncertainty
Present trade-offs

Labels to Suggest

Type: bug, enhancement, optimization, code-quality
Component: database, HTTP-API, fork-choice, beacon-processor
Effort: good first issue, low-hanging-fruit, major-task

Output

Provide the complete issue text ready to paste into GitHub.

After Feedback

If the developer refines your issue/PR text or suggests a different format:

Apply their feedback to the current issue
Offer to update docs - Ask: "Should I update .ai/ISSUES.md to capture this preference?"
Document patterns the team prefers that aren't yet in the guidelines

1.3 KiB Raw Blame History