Skip to content

Commit 9fbac5d

Browse files
robertsLandoclaude
andauthored
chore: add CLAUDE.md referencing shared copilot instructions (#66)
## Summary - Adds a `CLAUDE.md` file that points to `.github/copilot-instructions.md` as the single source of truth for project guidelines - Includes only a minimal quick-reference section with essential commands (`build`, `lint`, `test`, `emulator`) - Avoids duplicating any content already covered in the copilot instructions ## Rationale Rather than maintaining two separate instruction files with overlapping content, this approach keeps `.github/copilot-instructions.md` as the authoritative reference and has `CLAUDE.md` simply redirect to it. This ensures consistency and reduces maintenance burden. ## Test plan - [ ] Verify `CLAUDE.md` renders correctly on GitHub - [ ] Verify the relative link to `.github/copilot-instructions.md` resolves properly 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0a64537 commit 9fbac5d

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with this repository.
4+
5+
## Project Instructions
6+
7+
All coding standards, architecture patterns, testing guidelines, and contribution requirements are maintained in a single shared location:
8+
9+
**[.github/copilot-instructions.md](.github/copilot-instructions.md)**
10+
11+
That file is the primary reference for:
12+
13+
- Code style and TypeScript conventions
14+
- Architecture patterns (event-driven design, buffer management, ASN.1 encoding)
15+
- BACnet protocol specifics
16+
- Testing strategy and coverage requirements
17+
- Git workflow and conventional commits
18+
- Pull request quality standards
19+
20+
## Quick Reference
21+
22+
```bash
23+
# Build
24+
npm run build
25+
26+
# Lint
27+
npm run lint
28+
npm run lint:fix
29+
30+
# Test
31+
npm run test:all # Run all tests
32+
npm run test:unit # Unit tests only
33+
npm run test:integration # Integration tests only
34+
npm run test:compliance # Compliance tests only
35+
36+
# Development
37+
npm run emulator:start # Start BACnet device emulator
38+
npm run docs # Generate API docs with TypeDoc
39+
```

0 commit comments

Comments
 (0)