-
Notifications
You must be signed in to change notification settings - Fork 4.2k
GH-50373: [Dev][Developer Tools] Add root AGENTS.md file #50375
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
thisisnic
wants to merge
5
commits into
apache:main
Choose a base branch
from
thisisnic:GH-50373-agents-at-root
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3ad017f
Add generic AGENTS.md file
thisisnic 4c7cd0b
Potential fix for pull request finding
thisisnic ff53a30
Update AGENTS file with feedback in mind
thisisnic 00d0a5b
Enhance phrasing
thisisnic 2a09a5e
Potential fix for pull request finding
thisisnic File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| <!--- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| # AGENTS.md | ||
|
|
||
| This file provides guidance for AI coding agents working on Apache Arrow. | ||
|
|
||
| Apache Arrow is a multi-language toolbox for accelerated data interchange | ||
| and in-memory processing. | ||
|
|
||
| ## Repository Layout | ||
|
|
||
| | Directory | Description | | ||
| |-----------|-------------| | ||
| | `cpp/` | Core C++ library (libarrow, Parquet, Flight, Gandiva, etc.) | | ||
| | `python/` | PyArrow (Python bindings for libarrow) | | ||
| | `r/` | R package | | ||
| | `c_glib/` | C/GLib bindings | | ||
| | `ruby/` | Ruby bindings | | ||
| | `matlab/` | MATLAB implementation | | ||
| | `docs/` | Sphinx documentation source | | ||
| | `ci/` | CI configuration (Docker, scripts) | | ||
| | `dev/` | Developer tools and release scripts | | ||
| | `format/` | Arrow columnar format specification | | ||
| | `testing/` | Shared test data (integration testing) | | ||
|
|
||
|
Comment on lines
+29
to
+42
|
||
| Several implementations have moved to their own repositories: | ||
|
|
||
| - **Java**: [apache/arrow-java](https://github.com/apache/arrow-java) | ||
| - **Go**: [apache/arrow-go](https://github.com/apache/arrow-go) | ||
| - **Rust**: [apache/arrow-rs](https://github.com/apache/arrow-rs) | ||
| - **C#**: [apache/arrow-csharp](https://github.com/apache/arrow-csharp) | ||
| - **JavaScript**: [apache/arrow-js](https://github.com/apache/arrow-js) | ||
| - **Swift**: [apache/arrow-swift](https://github.com/apache/arrow-swift) | ||
| - **Julia**: [apache/arrow-julia](https://github.com/apache/arrow-julia) | ||
|
|
||
| ## Git Conventions | ||
|
|
||
| ### Remote Names | ||
|
|
||
| - `upstream` → `apache/arrow` (fetch from here) | ||
| - `origin` → your fork (push PR branches here) | ||
|
|
||
| Verify with `git remote -v` before pushing. Never push directly to | ||
| `upstream`. | ||
|
|
||
| ### Commit Messages | ||
|
|
||
| Use imperative mood and focus on *why*, not *what*. | ||
|
|
||
| Good: `Fix UnionArray validation when type codes are non-contiguous` | ||
| Bad: `Fixed the bug in union array` | ||
|
|
||
| ## Issue Conventions | ||
|
|
||
| - Follow the issue templates at | ||
| https://github.com/apache/arrow/tree/main/.github/ISSUE_TEMPLATE | ||
| when creating a new issue. | ||
| - Do NOT include a `GH-` prefix in issue titles (that is only for PRs). | ||
| - Search existing issues before creating a new one. | ||
|
thisisnic marked this conversation as resolved.
|
||
|
|
||
| ## Pull Request Conventions | ||
|
|
||
| ### Title Format | ||
|
|
||
|
thisisnic marked this conversation as resolved.
|
||
| ``` | ||
| GH-<issue-number>: [Component] Short description | ||
| ``` | ||
|
|
||
| Example: `GH-14736: [C++][Python] Ensure no validity bitmap in UnionArray::SetData` | ||
|
|
||
| ### MINOR Changes | ||
|
|
||
| For trivial documentation or typo fixes affecting no more than 2 files and | ||
| no more than 500 words, you may skip creating an issue and prefix the PR | ||
| title with `MINOR:` instead: | ||
|
|
||
|
Comment on lines
+100
to
+105
|
||
| ``` | ||
| MINOR: [Docs] Fix typo in memory.rst | ||
| ``` | ||
|
|
||
| Do NOT combine `MINOR:` with a `GH-` number. | ||
|
thisisnic marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### PR Description | ||
|
|
||
| Fill in all four sections of the PR template at | ||
| https://github.com/apache/arrow/blob/main/.github/pull_request_template.md | ||
|
|
||
| Descriptions should be concise and to the point — do not restate things | ||
| that are obvious from reading the diff. | ||
|
|
||
| ### AI-Generated Content | ||
|
|
||
| Never open pull requests or post comments to GitHub automatically. | ||
| A human must review all changes locally and write the PR description | ||
| before submitting. | ||
|
|
||
| ## Pre-commit Hooks | ||
|
|
||
| ```bash | ||
| pip install pre-commit | ||
| pre-commit install | ||
| pre-commit run -a # all hooks | ||
| pre-commit run --all-files <hook-alias> # e.g. python, cpp (see aliases in .pre-commit-config.yaml) | ||
|
Comment on lines
+129
to
+130
|
||
| ``` | ||
|
|
||
| Always run the relevant pre-commit checks before submitting a PR. | ||
|
|
||
| ## Testing | ||
|
|
||
| Run relevant tests locally before submitting a PR. See the | ||
| [Testing](https://arrow.apache.org/docs/developers/guide/step_by_step/testing.html) | ||
| section of the contributor guide for component-specific instructions. | ||
|
|
||
| ## AI-Generated Code Policy | ||
|
|
||
| See: https://arrow.apache.org/docs/dev/developers/overview.html#ai-generated-code | ||
|
|
||
| ## Component-Specific Guides | ||
|
|
||
| Some subdirectories may contain their own `AGENTS.md` with language-specific | ||
| build instructions, testing commands, and coding conventions. Check the | ||
| relevant component directory before starting work. | ||
|
|
||
| ## Further Resources | ||
|
|
||
| - [New Contributor's Guide](https://arrow.apache.org/docs/developers/guide/index.html) | ||
| - [Contributing Overview](https://arrow.apache.org/docs/developers/overview.html) | ||
| - [CONTRIBUTING.md](CONTRIBUTING.md) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.