Skip to content

docs: add fastfields-helpers to the CONTRIBUTING.md layer diagram#11

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

Merged
balbasty merged 2 commits into from
Aug 18, 2026
Merged

docs: add fastfields-helpers to the CONTRIBUTING.md layer diagram #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05631d3
docs: add fastfields-helpers to the layer diagram and CI note
balbasty Aug 18, 2026
1deedaf
Fix: restore full CONTRIBUTING.md content (previous commit accidental…
balbasty Aug 18, 2026
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
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ fastfields-kernels voxelwise math (header-only, backend-agnostic, templat
└─ fastfields-bind-py (fastfields.dlpack, nanobind)
├─ fastfields-numpy / -cupy / -torch (fastfields.{numpy,cupy,torch})
└─ fastfields (fastfields.auto)

fastfields-helpers (fastfields.helpers -- pure-Python enums/normalisers, zero deps)
└─ consumed by fastfields-numpy / -cupy / -torch / fastfields, as an
independent sibling of fastfields-dlpack (neither depends on the other)
```

Each repo has a **`CLAUDE.md`** describing its role, layout, and conventions;
Expand DownExpand Up@@ -246,9 +250,13 @@ keeps one-line callers per package; we inline the steps for now — extract a
- `lint.yaml` — `ruff check`, `ruff format --check`, `codespell` (push + PR).
- `test.yaml` — a Python-version matrix: checkout `submodules: recursive`,
install the package `.[test]`, run `pytest` from a neutral cwd. Path-filter on
`fastfields/**`, `tests/**`, `pyproject.toml`. Wrapper repos need
`fastfields-dlpack`; until it is on PyPI / the wheel index they build it from
the sibling repo.
`fastfields/**`, `tests/**`, `pyproject.toml`. Wrapper repos (numpy/torch/cupy)
and the umbrella `fastfields` repo need `fastfields-dlpack`; until it is on
PyPI / the wheel index they build it from the sibling repo. `fastfields-helpers`
is the one repo that needs neither — it is pure Python with zero dependencies
— so its `test.yaml` passes the reusable workflow's `needs-dlpack: false`
input to skip that build entirely (fastfields/.github#10) rather than
compiling the whole C++ chain to test stdlib-only code.
- `docs.yaml` — build the site and deploy to Pages (`permissions: pages: write,
id-token: write`, `concurrency: {group: pages}`).
- C++ repos get a `test.yaml` too: the **cpu-lib** one (`make test
Expand Down