-
Notifications
You must be signed in to change notification settings - Fork 495
Add .claude directory
#1740
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
Open
xavdid-stripe
wants to merge
1
commit into
master
Choose a base branch
from
add-claude-config
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add .claude directory
#1740
Changes from all commits
Commits
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-python | ||
|
|
||
| ## Testing | ||
|
|
||
| - Run all tests: `just test` | ||
| - Run a specific test by name: `just test-one test_name` | ||
| - Run a specific test file: `just test tests/path/to/test_file.py` | ||
|
|
||
| ## Formatting & Linting | ||
|
|
||
| - Format: `just format` (uses ruff) | ||
| - Lint: `just lint` (uses flake8) | ||
| - Typecheck: `just typecheck` (uses pyright) | ||
|
|
||
| ## Key Locations | ||
|
|
||
| - HTTP client (request execution, retries, headers): `stripe/_http_client.py` | ||
| - Main client class: `stripe/_stripe_client.py` | ||
| - Client options/config: `stripe/_client_options.py` | ||
| - API requestor (request building, auth): `stripe/_api_requestor.py` | ||
|
|
||
| ## 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. | ||
| - Most files under `stripe/` resource subdirectories (e.g. `stripe/_customer.py`, `stripe/params/`, `stripe/resources/`) are generated. | ||
| - The HTTP client layer (`_http_client.py`, `_stripe_client.py`, `_api_requestor.py`, `_client_options.py`) is NOT generated. | ||
|
|
||
| ## Conventions | ||
|
|
||
| - Uses `requests` library by default for sync HTTP, `httpx` for async | ||
| - Type hints throughout | ||
| - Virtual env managed in `.venv/`; `just` recipes handle setup automatically | ||
| - Work is not complete until `just test`, `just lint` and `just typecheck` complete successfully. | ||
| - All code must run on all supported Python 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. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was causing my VSCode to act up, so I pulled it. Can remove from PR if other people need it.