Skip to content

Commit 1f75b18

Browse files
authored
chore: add Claude Code settings and agent instructions (#15978)
Add project configuration for Claude Code AI assistant. `.claude/settings.json` grants read-only permissions for common commands (git, yarn, docker, make) and allows Sentry skills and documentation domains. This enables Claude Code to explore the codebase without prompting for every read operation. `AGENTS.md` documents key project conventions: package manager (yarn), development commands, project structure, and code style expectations. `CLAUDE.md` symlinks to it for compatibility with different agent naming conventions.
1 parent 4a5c64c commit 1f75b18

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

.claude/settings.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"Bash(ls:*)",
5+
"Bash(pwd:*)",
6+
"Bash(find:*)",
7+
"Bash(file:*)",
8+
"Bash(stat:*)",
9+
"Bash(wc:*)",
10+
"Bash(head:*)",
11+
"Bash(tail:*)",
12+
"Bash(cat:*)",
13+
"Bash(tree:*)",
14+
"Bash(git status:*)",
15+
"Bash(git log:*)",
16+
"Bash(git diff:*)",
17+
"Bash(git show:*)",
18+
"Bash(git branch:*)",
19+
"Bash(git remote:*)",
20+
"Bash(git tag:*)",
21+
"Bash(git stash list:*)",
22+
"Bash(git rev-parse:*)",
23+
"Bash(gh pr view:*)",
24+
"Bash(gh pr list:*)",
25+
"Bash(gh pr checks:*)",
26+
"Bash(gh pr diff:*)",
27+
"Bash(gh issue view:*)",
28+
"Bash(gh issue list:*)",
29+
"Bash(gh run view:*)",
30+
"Bash(gh run list:*)",
31+
"Bash(gh run logs:*)",
32+
"Bash(gh repo view:*)",
33+
"Bash(gh api:*)",
34+
"Bash(node --version:*)",
35+
"Bash(yarn list:*)",
36+
"Bash(yarn info:*)",
37+
"Bash(yarn why:*)",
38+
"Bash(tsc --version:*)",
39+
"Bash(docker --version:*)",
40+
"Bash(docker ps:*)",
41+
"Bash(docker images:*)",
42+
"Bash(docker-compose ps:*)",
43+
"Bash(docker-compose config:*)",
44+
"Bash(make --version:*)",
45+
"Bash(make -n:*)",
46+
"Skill(sentry-skills:commit)",
47+
"Skill(sentry-skills:create-pr)",
48+
"Skill(sentry-skills:code-review)",
49+
"Skill(sentry-skills:find-bugs)",
50+
"Skill(sentry-skills:deslop)",
51+
"Skill(sentry-skills:iterate-pr)",
52+
"Skill(sentry-skills:claude-settings-audit)",
53+
"Skill(sentry-skills:agents-md)",
54+
"WebFetch(domain:docs.sentry.io)",
55+
"WebFetch(domain:develop.sentry.dev)",
56+
"WebFetch(domain:docs.github.com)",
57+
"WebFetch(domain:cli.github.com)",
58+
"WebFetch(domain:react.dev)",
59+
"WebFetch(domain:nextjs.org)",
60+
"WebFetch(domain:docs.docker.com)"
61+
],
62+
"deny": []
63+
}
64+
}

AGENTS.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Agent Instructions
2+
3+
## Package Manager
4+
Use **yarn**: `yarn install`, `yarn dev`, `yarn build`, `yarn test`
5+
6+
## Commit Attribution
7+
AI commits MUST include:
8+
```
9+
Co-Authored-By: Claude <[email protected]>
10+
```
11+
12+
## Development
13+
- `yarn dev` - Start dev server with Sentry sidecar
14+
- `yarn dev:minimal` - Start dev server without sidecar
15+
- `yarn build` - Production build
16+
- `yarn test` - Run tests with vitest
17+
- `yarn lint` - Run all linters
18+
- `yarn lint:fix` - Auto-fix lint issues
19+
20+
## Tech Stack
21+
- Next.js 15 with App Router
22+
- React 19
23+
- TypeScript
24+
- Tailwind CSS
25+
- MDX for documentation content
26+
- Sentry SDK (`@sentry/nextjs`)
27+
28+
## Project Structure
29+
- `app/` - Next.js app router pages and layouts
30+
- `src/` - Source code (components, utilities)
31+
- `docs/` - MDX documentation content
32+
- `develop-docs/` - Developer documentation (submodule)
33+
- `includes/` - Reusable MDX includes
34+
- `platform-includes/` - Platform-specific MDX content
35+
- `public/` - Static assets
36+
37+
## Code Style
38+
- ESLint + Prettier enforced via pre-commit hooks
39+
- Use TypeScript strict mode
40+
- Follow existing patterns in codebase
41+
42+
## Testing
43+
Run `yarn test` for vitest. Tests live alongside source files or in `__tests__` directories.
44+
45+
## CLI Commands
46+
| Command | Description |
47+
|---------|-------------|
48+
| `make develop` | Initial setup |
49+
| `make test` | Run tests |
50+
| `yarn lint:ts` | TypeScript check |
51+
| `yarn lint:eslint` | ESLint check |
52+
| `yarn lint:prettier` | Prettier check |

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)