Skip to content

Commit 7a0edd3

Browse files
committed
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
1 parent 130a6b9 commit 7a0edd3

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

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+
`singed` makes it easy to get a flamegraph anywhere in a Ruby codebase. It wraps profiling with [stackprof](https://github.com/tmm1/stackprof) or [rbspy](https://github.com/rbspy/rbspy) and launches [speedscope](https://github.com/jlfwong/speedscope) to view results.
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+
25+
## Architecture
26+
27+
- `lib/singed.rb` — main entry point; provides `Singed.flamegraph` block helper
28+
- `lib/singed/` — core classes: flamegraph output handling, stackprof/rbspy integrations, speedscope launcher
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)