Skip to content

Commit d4ca194

Browse files
timsaucerclaude
andcommitted
Move user guide from python/datafusion/AGENTS.md to SKILL.md
The in-wheel AGENTS.md was not a real distribution channel -- no shipping agent walks site-packages for AGENTS.md files. Moving to SKILL.md at the repo root, with YAML frontmatter, lets the skill ecosystems (npx skills, Claude Code plugin marketplaces, community aggregators) discover it. Update the pointers in the contributor AGENTS.md and the __init__.py module docstring accordingly. The docstring now references the GitHub URL since the file no longer ships with the wheel. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 540503d commit d4ca194

3 files changed

Lines changed: 8 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
This file is for agents working **on** the datafusion-python project (developing,
2323
testing, reviewing). If you need to **use** the DataFusion DataFrame API (write
2424
queries, build expressions, understand available functions), see the user-facing
25-
guide at [`python/datafusion/AGENTS.md`](python/datafusion/AGENTS.md).
25+
skill at [`SKILL.md`](SKILL.md).
2626

2727
## Skills
2828

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@
1717
under the License.
1818
-->
1919

20+
---
21+
name: datafusion-python
22+
description: Use when the user is writing datafusion-python (Apache DataFusion Python bindings) DataFrame or SQL code. Covers imports, data loading, DataFrame operations, expression building, SQL-to-DataFrame mappings, idiomatic patterns, and common pitfalls.
23+
---
24+
2025
# DataFusion Python DataFrame API Guide
2126

2227
## What Is DataFusion?

python/datafusion/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@
5151
5252
For a comprehensive guide to the DataFrame API -- including a SQL-to-DataFrame
5353
reference table, expression building, idiomatic patterns, and common pitfalls --
54-
see the ``AGENTS.md`` file shipped alongside this package.
54+
see ``SKILL.md`` at the root of the datafusion-python repository:
55+
https://github.com/apache/datafusion-python/blob/main/SKILL.md
5556
5657
Full documentation: https://datafusion.apache.org/python
5758
"""

0 commit comments

Comments
 (0)