Skip to content

Commit 029d01f

Browse files
committed
Merge branch 'main' into feat/module-docstrings
2 parents 3cf243f + 8a5d783 commit 029d01f

4 files changed

Lines changed: 787 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@
1717
under the License.
1818
-->
1919

20-
# Agent Instructions
20+
# Agent Instructions for Contributors
21+
22+
This file is for agents working **on** the datafusion-python project (developing,
23+
testing, reviewing). If you need to **use** the DataFusion DataFrame API (write
24+
queries, build expressions, understand available functions), see the user-facing
25+
skill at [`SKILL.md`](SKILL.md).
26+
27+
## Skills
2128

2229
This project uses AI agent skills stored in `.ai/skills/`. Each skill is a directory containing a `SKILL.md` file with instructions for performing a specific task.
2330

@@ -26,6 +33,31 @@ Skills follow the [Agent Skills](https://agentskills.io) open standard. Each ski
2633
- `SKILL.md` — The skill definition with YAML frontmatter (name, description, argument-hint) and detailed instructions.
2734
- Additional supporting files as needed.
2835

36+
## Pull Requests
37+
38+
Every pull request must follow the template in
39+
`.github/pull_request_template.md`. The description must include these sections:
40+
41+
1. **Which issue does this PR close?** — Link the issue with `Closes #NNN`.
42+
2. **Rationale for this change** — Why the change is needed (skip if the issue
43+
already explains it clearly).
44+
3. **What changes are included in this PR?** — Summarize the individual changes.
45+
4. **Are there any user-facing changes?** — Note any changes visible to users
46+
(new APIs, changed behavior, new files shipped in the package, etc.). If
47+
there are breaking changes to public APIs, add the `api change` label.
48+
49+
## Pre-commit Checks
50+
51+
Always run pre-commit checks **before** committing. The hooks are defined in
52+
`.pre-commit-config.yaml` and run automatically on `git commit` if pre-commit
53+
is installed as a git hook. To run all hooks manually:
54+
55+
```bash
56+
pre-commit run --all-files
57+
```
58+
59+
Fix any failures before committing.
60+
2961
## Python Function Docstrings
3062

3163
Every Python function must include a docstring with usage examples.

0 commit comments

Comments
 (0)