Skip to content

Commit e1ea364

Browse files
committed
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
1 parent 7319a96 commit e1ea364

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to AI coding agents when working with code in this repository.
4+
5+
## What this project is
6+
7+
`visualize_packs` is a Ruby gem that generates visual diagrams of pack connections in a Rails application using [packs](https://github.com/rubyatscale/packs) and packwerk. It helps teams understand dependency relationships and identify architectural issues.
8+
9+
## Commands
10+
11+
```bash
12+
bundle install
13+
14+
# Run all tests (RSpec)
15+
bundle exec rspec
16+
17+
# Run a single spec file
18+
bundle exec rspec spec/path/to/spec.rb
19+
20+
# Type checking (Sorbet)
21+
bundle exec srb tc
22+
```
23+
24+
## Architecture
25+
26+
- `lib/visualize_packs.rb` — entry point; reads pack configuration and produces graph output
27+
- `lib/visualize_packs/` — core logic: graph building, layout, and rendering (e.g. to DOT/SVG)
28+
- `spec/` — RSpec tests; `spec/fixtures/` holds sample pack configurations

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)