From 98b151a542946ee688eb3a6bc168ed4e1162ba9d Mon Sep 17 00:00:00 2001 From: Douglas Eichelberger Date: Thu, 5 Mar 2026 11:40:49 -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..e125a41 --- /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 + +`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. + +## 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/code_teams.rb` — public API: `CodeTeams.all`, `CodeTeams.find`, team plugin registration +- `lib/code_teams/` — `Team` struct, YAML parsing, plugin interface, and built-in plugins +- `spec/` — RSpec tests; `spec/fixtures/` holds sample `config/teams/` directories 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 f209095e6667c65e0ecad92c7ac0809ae9c09758 Mon Sep 17 00:00:00 2001 From: Douglas Eichelberger <697964+dduugg@users.noreply.github.com> Date: Thu, 5 Mar 2026 12:01:29 -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 e125a41..90e0974 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/code_teams.rb` — public API: `CodeTeams.all`, `CodeTeams.find`, team plugin registration - `lib/code_teams/` — `Team` struct, YAML parsing, plugin interface, and built-in plugins -- `spec/` — RSpec tests; `spec/fixtures/` holds sample `config/teams/` directories +- `spec/` — RSpec tests