Skip to content

Commit ffe0838

Browse files
timsaucerclaude
andcommitted
docs: add README section for AI coding assistants
Points users to the repo-root SKILL.md via the npx skills registry or a manual AGENTS.md / CLAUDE.md pointer. Implements PR 1c of the plan in #1394. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 8741d30 commit ffe0838

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,22 @@ You can verify the installation by running:
215215
'0.6.0'
216216
```
217217

218+
## Using DataFusion with AI coding assistants
219+
220+
This project ships a [`SKILL.md`](SKILL.md) at the repo root that teaches AI
221+
coding assistants how to write idiomatic DataFusion Python. It follows the
222+
[Agent Skills](https://agentskills.io) open standard.
223+
224+
**Preferred:** `npx skills add apache/datafusion-python` — installs the skill in
225+
Claude Code, Cursor, Windsurf, Cline, Codex, Copilot, Gemini CLI, and other
226+
supported agents.
227+
228+
**Manual:** paste this line into your project's `AGENTS.md` / `CLAUDE.md`:
229+
230+
```
231+
For DataFusion Python code, see https://github.com/apache/datafusion-python/blob/main/SKILL.md
232+
```
233+
218234
## How to develop
219235

220236
This assumes that you have rust and cargo installed. We use the workflow recommended by [pyo3](https://github.com/PyO3/pyo3) and [maturin](https://github.com/PyO3/maturin). The Maturin tools used in this workflow can be installed either via `uv` or `pip`. Both approaches should offer the same experience. It is recommended to use `uv` since it has significant performance improvements

0 commit comments

Comments
 (0)