Skip to content

Commit 63f4bd3

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

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

AGENTS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
This file provides guidance to AI coding agents when working with code in this repository.
2+
3+
## What this project is
4+
5+
`code_ownership` is a Ruby gem that helps engineering teams declare and query ownership of code. It supports multiple ownership mechanisms: package-based ownership (via `package.yml`), team-based glob patterns, and file annotations.
6+
7+
## Commands
8+
9+
```bash
10+
bundle install
11+
12+
# Run all tests (RSpec) — note: includes a native extension compile step
13+
bundle exec rake default # compiles extension + runs specs
14+
15+
# Run specs directly (after compiling)
16+
bundle exec rspec
17+
18+
# Run a single spec file
19+
bundle exec rspec spec/path/to/spec.rb
20+
21+
# Lint
22+
bundle exec rubocop
23+
bundle exec rubocop -a # auto-correct
24+
25+
# Type checking (Sorbet)
26+
bundle exec srb tc
27+
```
28+
29+
## Architecture
30+
31+
- `lib/code_ownership.rb` — public API: `CodeOwnership.for_file`, `CodeOwnership.validate!`, `CodeOwnership.for_team`
32+
- `lib/code_ownership/` — mapper plugins (each ownership mechanism is a mapper), `Ownership` value object, configuration loading, and CLI
33+
- `spec/` — RSpec tests

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)