-
Notifications
You must be signed in to change notification settings - Fork 628
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.
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
Merged
Add .claude directory
#1800
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/`. Be careful reading files in that directory, since they're very large and may blow up your context window | ||
|
|
||
| ## 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.