Skip to content
Merged
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions CLAUDE.md
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`

Comment thread
dsotirho-ucsc marked this conversation as resolved.
- 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
Loading