Skip to content

GH-50342: [Python] Add AGENTS.md#50626

Open
ybapat wants to merge 1 commit into
apache:mainfrom
ybapat:GH-50342-python-agents-md
Open

GH-50342: [Python] Add AGENTS.md#50626
ybapat wants to merge 1 commit into
apache:mainfrom
ybapat:GH-50342-python-agents-md

Conversation

@ybapat

@ybapat ybapat commented Jul 24, 2026

Copy link
Copy Markdown

Rationale for this change

Add an AGENTS.md file to the python/ directory to help AI agents and new contributors understand how to build, test, and contribute to PyArrow effectively. This follows the pattern established by the root AGENTS.md (GH-50373) and the R AGENTS.md (GH-49607).

Note: This PR was created with the assistance of an AI tool (Claude). The change consists solely of documentation.

What changes are included in this PR?

Adds python/AGENTS.md covering:

  • Project overview (Cython-based Python bindings for Arrow C++)
  • AI disclosure requirement
  • Explanation of Cython source files and type stubs (hand-written vs. generated)
  • Development setup via conda
  • Building Arrow C++ and PyArrow (editable mode)
  • Running tests with pytest, including optional feature group flags (--enable-<group> / --disable-<group>)
  • Code style via pre-commit (python alias)
  • Type checking with mypy, pyright, and ty
  • File structure table
  • PR title format and description template
  • Links to further resources

Are these changes tested?

No — this is a documentation-only change.

Are there any user-facing changes?

No.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ybapat
ybapat requested review from AlenkaF, raulcd and rok as code owners July 24, 2026 04:45
@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #50342 has been automatically assigned in GitHub to PR creator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant