Skip to content

Add .claude directory #1800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xavdid-stripe merged 3 commits into from
Feb 27, 2026
+47 −0
Merged

Add .claude directory #1800

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecdfe67
add .claude directory
xavdid-stripe Feb 26, 2026
75545d8
update instructions
xavdid-stripe Feb 27, 2026
793b767
Merge branch 'master' into add-claude-config
xavdid-stripe Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .claude/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# stripe-ruby

## Testing

- Run all tests: `just test`
- Tests use Rake (`bundle exec rake test`)
- Typecheck: `just typecheck` (Sorbet, requires Ruby >= 2.7)

## Formatting & Linting

- Format: `just format` (uses rubocop with auto-correct)
- Lint check: `just format-check` (rubocop without auto-correct)

## Key Locations

- Main client (HTTP requests, headers, auth): `lib/stripe/stripe_client.rb`
- Connection management: `lib/stripe/connection_manager.rb`
- Version: `lib/stripe/version.rb`
- Sorbet type definitions: `rbi/`. NEVER read `rbi/stripe.rbi`, since it's a huge file that collects data already present in other `.rbi` files

## Generated Code

- Files containing `File generated from our OpenAPI spec` at the top are generated; do not edit. Similarly, any code block starting with `The beginning of the section generated from our OpenAPI spec` is generated and should not be edited directly.
- If something in a generated file/range needs to be updated, add a summary of the change to your report but don't attempt to edit it directly.
- Resource classes under `lib/stripe/resources/` are largely generated.
- `stripe_client.rb`, `connection_manager.rb`, and core infrastructure files are NOT generated.

## Conventions

- Uses Ruby's standard `Net::HTTP` library
- Bundler for gem management
- Rubocop for style enforcement
- Sorbet for optional type checking
- Work is not complete until `just test` and `just typecheck` complete successfully.
- All code must run on all supported Ruby versions (full list in the test section of @.github/workflows/ci.yml)

### Comments

- Comments MUST only be used to:
1. Document a function
2. Explain the WHY of a piece of code
3. Explain a particularly complicated piece of code
- Comments NEVER should be used to:
1. Say what used to be there. That's no longer relevant!
2. Explain the WHAT of a piece of code (unless it's very non-obvious)

It's ok not to put comments on/in a function if their addition wouldn't meaningfully clarify anything.