Skip to content

Commit 98b151a

Browse files
committed
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
1 parent 8018917 commit 98b151a

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+
`code_teams` is a low-dependency, plugin-based Ruby gem for declaring and querying engineering teams within a codebase. Teams are defined in `config/teams/*.yml` files, and plugins extend validation and querying behavior per organization.
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/code_teams.rb` — public API: `CodeTeams.all`, `CodeTeams.find`, team plugin registration
31+
- `lib/code_teams/``Team` struct, YAML parsing, plugin interface, and built-in plugins
32+
- `spec/` — RSpec tests; `spec/fixtures/` holds sample `config/teams/` directories

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)