Skip to content

Commit cfdbd79

Browse files
dduuggclaude
andauthored
Add AGENTS.md and CLAUDE.md for AI coding agent guidance (#55)
* Add AGENTS.md and CLAUDE.md for AI coding agent guidance * Fix inaccuracies in AGENTS.md - Remove redundant heading that repeats the filename - Fix incorrect spec/fixtures/ references where that directory doesn't exist - Fix Claude-specific intro text to be agent-agnostic (pks only) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent 6a4e614 commit cfdbd79

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
This file provides guidance to AI coding agents when working with code in this repository.
2+
3+
## What this project is
4+
5+
`pack_stats` collects and reports modularization statistics about a Rails application using packwerk. It sends opinionated metrics (e.g. violation counts, pack sizes, ownership breakdown) to DataDog and other observability systems.
6+
7+
## Commands
8+
9+
```bash
10+
bundle install
11+
12+
# Run all tests (RSpec)
13+
bundle exec rspec
14+
15+
# Run a single spec file
16+
bundle exec rspec spec/path/to/spec.rb
17+
18+
# Type checking (Sorbet)
19+
bundle exec srb tc
20+
```
21+
22+
## Architecture
23+
24+
- `lib/pack_stats.rb` — entry point; `PackStats.report_to_datadog!` is the primary public method
25+
- `lib/pack_stats/` — metric collectors (per-pack and per-team stats), DataDog gauge/distribution reporters, and configuration
26+
- `spec/` — RSpec tests

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)