Skip to content

Commit 1d27e8f

Browse files
committed
Add instructions on using the check-upstream skill
1 parent a657f7d commit 1d27e8f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,33 @@ There are scripts in `ci/scripts` for running Rust and Python linters.
312312
./ci/scripts/rust_toml_fmt.sh
313313
```
314314

315+
## Checking Upstream DataFusion Coverage
316+
317+
This project includes a [Claude Code](https://claude.com/claude-code) skill for auditing which
318+
features from the upstream Apache DataFusion Rust library are not yet exposed in these Python
319+
bindings. This is useful when adding missing functions, auditing API coverage, or ensuring parity
320+
with upstream.
321+
322+
To use it, run the `/check-upstream` slash command inside Claude Code with an optional area argument:
323+
324+
```
325+
/check-upstream scalar functions
326+
/check-upstream aggregate functions
327+
/check-upstream window functions
328+
/check-upstream dataframe
329+
/check-upstream session context
330+
/check-upstream all
331+
```
332+
333+
If no argument is provided, it defaults to checking all areas. The skill will fetch the upstream
334+
DataFusion documentation, compare it against the functions and methods exposed in this project, and
335+
produce a coverage report listing what is currently exposed and what is missing.
336+
337+
The skill definition lives in `.claude/skills/check-upstream/SKILL.md`. Note that the `/check-upstream`
338+
slash command is a [Claude Code](https://claude.com/claude-code) feature, but the underlying
339+
methodology described in the skill file can be followed manually or by another AI coding agent if
340+
directed to read and follow the instructions in that file.
341+
315342
## How to update dependencies
316343

317344
To change test dependencies, change the `pyproject.toml` and run

0 commit comments

Comments
 (0)