Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
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
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md