Skip to content

Commit bc6a4cc

Browse files
dduuggclaude
andauthored
Add AGENTS.md and CLAUDE.md for AI coding agent guidance (#63)
* 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 f869297 commit bc6a4cc

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

AGENTS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
This file provides guidance to AI coding agents when working with code in this repository.
2+
3+
## What this project is
4+
5+
`packwerk-extensions` provides checker extensions for [packwerk](https://github.com/Shopify/packwerk) 3, a gradual modularization platform for Ruby. It ships `privacy`, `visibility`, `folder_privacy`, and `layer` checkers that enforce boundaries between packages.
6+
7+
## Commands
8+
9+
```bash
10+
bundle install
11+
12+
# Run all tests (minitest)
13+
bundle exec rake test
14+
15+
# Run a single test file
16+
bundle exec ruby -Ilib -Itest test/path/to/test.rb
17+
18+
# Lint
19+
bundle exec rubocop
20+
bundle exec rubocop -a # auto-correct
21+
22+
# Type checking (Sorbet)
23+
bundle exec srb tc
24+
```
25+
26+
## Architecture
27+
28+
- `lib/packwerk/` — checker implementations, each as a class that implements the packwerk checker interface
29+
- `test/` — minitest tests; `test/fixtures/` holds sample Rails app structures used in tests
30+
- Each checker (e.g. `privacy.rb`, `visibility.rb`, `layer_checker.rb`) reads `package.yml` metadata and decides whether a reference crosses a boundary

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)