From 4185256c8f3a58065661924d1c37f0bf01d769c2 Mon Sep 17 00:00:00 2001 From: Douglas Eichelberger Date: Thu, 5 Mar 2026 11:40:40 -0800 Subject: [PATCH 1/2] Add AGENTS.md and CLAUDE.md for AI coding agent guidance --- AGENTS.md | 32 ++++++++++++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 33 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..efe92f8 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,32 @@ +# AGENTS.md + +This file provides guidance to AI coding agents when working with code in this repository. + +## What this project is + +`danger-packwerk` is a [Danger](https://danger.systems/ruby/) plugin that integrates packwerk into pull request workflows. It runs `packwerk check` and posts inline PR comments for any new boundary violations introduced by a diff. + +## Commands + +```bash +bundle install + +# Run all tests (RSpec) +bundle exec rspec + +# Run a single spec file +bundle exec rspec spec/path/to/spec.rb + +# Lint +bundle exec rubocop +bundle exec rubocop -a # auto-correct + +# Type checking (Sorbet) +bundle exec srb tc +``` + +## Architecture + +- `lib/danger_packwerk.rb` — Danger plugin entry point; defines the `packwerk` Danger DSL method +- `lib/danger_packwerk/` — core logic: runs packwerk, diffs violations against the base branch, formats inline GitHub review comments +- `spec/` — RSpec tests; `spec/fixtures/` contains sample packwerk output and diff fixtures diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md From 8cbc78e5d2924ea128b1948b09f4a7e6b1492633 Mon Sep 17 00:00:00 2001 From: Douglas Eichelberger <697964+dduugg@users.noreply.github.com> Date: Thu, 5 Mar 2026 12:01:31 -0800 Subject: [PATCH 2/2] 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) --- AGENTS.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index efe92f8..b49c507 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,3 @@ -# AGENTS.md - This file provides guidance to AI coding agents when working with code in this repository. ## What this project is @@ -29,4 +27,4 @@ bundle exec srb tc - `lib/danger_packwerk.rb` — Danger plugin entry point; defines the `packwerk` Danger DSL method - `lib/danger_packwerk/` — core logic: runs packwerk, diffs violations against the base branch, formats inline GitHub review comments -- `spec/` — RSpec tests; `spec/fixtures/` contains sample packwerk output and diff fixtures +- `spec/` — RSpec tests