Skip to content

adjusted claude.md to use source of truth #107

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

Closed
konstibob wants to merge 1 commit into from
Closed

adjusted claude.md to use source of truth #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# zarr-java

## Before implementing a feature

Before implementing a feature, codec, data type, or behaviour change, check whether it already
exists or is specified elsewhere, and use that as context. Check in this order:

1. **zarr-specs**: the core Zarr v2/v3 specification. Is it specified, and how exactly?
- https://github.com/zarr-developers/zarr-specs (rendered: https://zarr-specs.readthedocs.io)
2. **zarr-extensions**: codecs, data types, chunk grids etc. that are not part of the core spec.
- Local clone: `../zarr-extensions`
- https://github.com/zarr-developers/zarr-extensions
3. **zarr-python**: the reference implementation. Defines the actual behaviour (defaults, edge
cases, error handling) that zarr-java must match.
- Local clone: `../zarr-python`; the installed version is in `.venv/lib/python*/site-packages/zarr`
- https://github.com/zarr-developers/zarr-python

Prefer the local clones (grep) over fetching the web. If the spec and zarr-python disagree,
match zarr-python and mention the discrepancy. If nothing relevant is found, say so before
designing the feature from scratch.
Loading