Skip to content

Commit 4b93ea7

Browse files
committed
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
1 parent b07656d commit 4b93ea7

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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+
`bigrails-redis` is a Redis connection manager for Rails applications that need to manage multiple named Redis connections. It supports connection pooling via [connection_pool](https://github.com/mperham/connection_pool).
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 (uses StandardRB, not RuboCop)
21+
bundle exec standardrb
22+
bundle exec standardrb --fix # auto-correct
23+
```
24+
25+
## Architecture
26+
27+
- `lib/bigrails/redis.rb` — entry point; provides `BigRails::Redis` configuration DSL
28+
- `lib/bigrails/redis/` — connection registry, per-connection config objects, and Rails railtie for auto-configuration from `config/redis.rb`
29+
- `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)