Skip to content

Add AGENTS.md / CLAUDE.md - #20939

Merged
Dandandan merged 2 commits into
apache:mainfrom
Dandandan:init_ai
Mar 14, 2026
Merged

Dandandan merged 2 commits into
apache:mainfrom
Dandandan:init_ai

Conversation

@Dandandan

@Dandandan Dandandan commented Mar 14, 2026 •

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Closes: #20941

Rationale for this change

Given that AI tools are used more and more, start with some AGENTS.md and CLAUDE.md that simply point to the Contributor Guide / Architecture Guide.

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@Dandandan
Dandandan marked this pull request as ready for review March 14, 2026 08:01
@Dandandan

Copy link
Copy Markdown
Contributor Author

Thanks @goldmedal

@Dandandan
Dandandan added this pull request to the merge queue Mar 14, 2026
Merged via the queue into apache:main with commit 9b7d092 Mar 14, 2026
8 checks passed
github-merge-queue Bot pushed a commit that referenced this pull request Mar 22, 2026
#20970)

## Which issue does this PR close?

  - Closes #.

 ## Rationale for this change

This PR is a follow-up to
#20939 from @Dandandan.

The goal is to make it easier for both humans and agents to get started
making changes in this repository and to create pull requests
efficiently.

The repository already had the necessary contributor information, but it
was spread across multiple documents and not easy to discover quickly.

  ## What changes are included in this PR?

This PR makes the most important setup, testing, and pre-PR checks
easier to find from the contributor guide and from `AGENTS.md`:

- Add a quick-start setup section to the contributor guide with the
shortest path to a working local environment.
- Add a testing quick-start section summarizing the most important tests
to run before submitting a PR.
- Add a “Before Submitting a PR” section to centralize formatting and
lint guidance.
- Update `AGENTS.md` to point to the canonical contributor guide
sections instead of duplicating setup and testing instructions.

  ## Are these changes tested?

  This PR updates documentation only.


  ## Are there any user-facing changes?

This improves contributor-facing documentation and makes setup / testing
guidance easier to discover, but it does not change DataFusion runtime
behavior or public APIs.

---------

Co-authored-by: Yongting You <[email protected]>
de-bgunter pushed a commit to de-bgunter/datafusion that referenced this pull request Mar 24, 2026
## Which issue does this PR close?

Closes: apache#20941
## Rationale for this change

Given that AI tools are used more and more, start with some `AGENTS.md`
and `CLAUDE.md` that simply point to the Contributor Guide /
Architecture Guide.

## What changes are included in this PR?

<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->

## Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->

## Are there any user-facing changes?

<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->

<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->

---------

Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
de-bgunter pushed a commit to de-bgunter/datafusion that referenced this pull request Mar 24, 2026
apache#20970)

## Which issue does this PR close?

  - Closes #.

 ## Rationale for this change

This PR is a follow-up to
apache#20939 from @Dandandan.

The goal is to make it easier for both humans and agents to get started
making changes in this repository and to create pull requests
efficiently.

The repository already had the necessary contributor information, but it
was spread across multiple documents and not easy to discover quickly.

  ## What changes are included in this PR?

This PR makes the most important setup, testing, and pre-PR checks
easier to find from the contributor guide and from `AGENTS.md`:

- Add a quick-start setup section to the contributor guide with the
shortest path to a working local environment.
- Add a testing quick-start section summarizing the most important tests
to run before submitting a PR.
- Add a “Before Submitting a PR” section to centralize formatting and
lint guidance.
- Update `AGENTS.md` to point to the canonical contributor guide
sections instead of duplicating setup and testing instructions.

  ## Are these changes tested?

  This PR updates documentation only.


  ## Are there any user-facing changes?

This improves contributor-facing documentation and makes setup / testing
guidance easier to discover, but it does not change DataFusion runtime
behavior or public APIs.

---------

Co-authored-by: Yongting You <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add initial AGENTS.md / CLAUDE.md file

2 participants