Skip to content

Commit 11440af

Browse files
committed
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
1 parent d34c394 commit 11440af

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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+
`query_packwerk` is a Ruby gem for querying and analyzing [packwerk](https://github.com/Shopify/packwerk) violations and dependencies. It provides a fluent API and an interactive console for exploring `package.yml` and `package_todo.yml` files.
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+
# Lint
21+
bundle exec rubocop
22+
bundle exec rubocop -a # auto-correct
23+
24+
# Type checking (Sorbet)
25+
bundle exec srb tc
26+
```
27+
28+
## Architecture
29+
30+
- `lib/query_packwerk.rb` — entry point and public API
31+
- `lib/query_packwerk/` — query classes for violations, packages, and dependency graphs; also includes an interactive console (REPL) interface
32+
- `spec/` — RSpec tests; `spec/fixtures/` holds sample packwerk app structures

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)