Skip to content

Commit 266ae30

Browse files
authored
docs: add AGENTS.md with build, test, and Spark diff guidance (#4083)
1 parent 26b0e85 commit 266ae30

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Agent Guidelines for Apache DataFusion Comet
21+
22+
Read the [Contributor Guide](docs/source/contributor-guide/index.md) before making changes.
23+
Relevant entry points:
24+
25+
- [Development Guide](docs/source/contributor-guide/development.md): build, test, and common
26+
pitfalls (including why `-pl` must not be used and the JVM/native build order).
27+
- [Spark SQL Tests](docs/source/contributor-guide/spark-sql-tests.md): the only supported way
28+
to modify files under `dev/diffs/`. **Never hand-edit a diff file.** Clone Spark, apply the
29+
existing diff, modify the Spark source, then regenerate the diff as documented there.
30+
- [Adding a New Expression](docs/source/contributor-guide/adding_a_new_expression.md) /
31+
[Adding a New Operator](docs/source/contributor-guide/adding_a_new_operator.md).
32+
- [Debugging Guide](docs/source/contributor-guide/debugging.md).
33+
34+
When opening a pull request, use the [PR template](.github/pull_request_template.md) and fill
35+
in every section.

0 commit comments

Comments
 (0)