-
Notifications
You must be signed in to change notification settings - Fork 3
Consider sharing CLAUDE.md (#7843) #7876
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
+37
−0
Merged
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,37 @@ | ||
| # Useful commands | ||
|
|
||
| - `make pep8` — lint check | ||
| - `make isort` — fix import ordering issues | ||
| - `make format` — fix other Python source code formatting issues | ||
| - `mypy` — type check (no arguments; checks only files configured in `.mypy.ini`) | ||
|
|
||
|
|
||
| # Guidelines | ||
|
|
||
| - In addition to the directives in this document, also respect those contained | ||
| in `CONTRIBUTING.rst` | ||
|
|
||
| - After making any code changes, always verify them with `make pep8` and `mypy` | ||
|
|
||
| - Don't worry about manually ordering imports. Instead, just run `make isort` | ||
|
|
||
| - When extracting code out of a module covered by `mypy` into a new module, | ||
| remember to add the new module to `.mypy.ini`. Ask for confirmation before | ||
| making changes that would reduce `mypy` coverage | ||
|
|
||
| - Remember that in `.mypy.ini`, there are two ways to configure a Python module | ||
| for coverage by `mypy`: *explicitly*, by listing its fully qualified module | ||
| path in the `modules` section of that file, or *implicitly*, by listing its | ||
| parent or ancestor package in the `packages` section | ||
|
|
||
| - Prefer to use `git mv` when renaming or moving files | ||
|
|
||
| - Do not commit any changes unless explicitly asked to do so. However, it's OK | ||
| to propose committing changes. When committing changes, include a trailer in | ||
| the commit message that attributes the change to you | ||
|
|
||
| - You can usually disregard any files under `attic/`, except for reference. | ||
| Never modify the attic, except when instructed to move files there. | ||
|
|
||
| - Passing `--config-file .mypy.ini` to `mypy` is unnecessary; since `.mypy.ini` | ||
| is the default config | ||
Oops, something went wrong.
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.