You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@auron.apache.org by "ShreyeshArangath (via GitHub)" <gi...@apache.org> on 2026/07/13 00:34:49 UTC
[PR] [AURON #2265] Add AI-assisted development guidance [auron]
ShreyeshArangath opened a new pull request, #2387:
URL: https://github.com/apache/auron/pull/2387
# Which issue does this PR close?\n\nCloses #2265\n\n# Rationale for this change\n\nAs AI-assisted development becomes more common, contributors need clear, project-specific guidance and policy guardrails that are easy to discover.\n\n# What changes are included in this PR?\n\n1. Adds a new root AGENTS.md as the canonical AI-assistance guidance entry point for this repository.\n2. Links to existing contributor documentation rather than duplicating process details.\n3. Adds a hard rule to avoid unreviewed third-party plugins/hooks/scripts and rely on approved repo tooling.\n4. Updates .github/pull_request_template.md to require generative-AI disclosure (Generated-by: ... or No) with ASF guidance link.\n\n# Are there any user-facing changes?\n\nNo runtime behavior changes; contributor/process documentation only.\n\n# How was this patch tested?\n\nDocumentation-only changes; validated content and links.\n\n# Was this patch authored or co-authored using generative AI tooling?\n\nGener
ated-by: GitHub Copilot CLI GPT-5.3-Codex\n
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [AURON #2265] Add AI-assisted development guidance [auron]
Posted by "ShreyeshArangath (via GitHub)" <gi...@apache.org>.
ShreyeshArangath commented on code in PR #2387:
URL: https://github.com/apache/auron/pull/2387#discussion_r3573264203
##########
.github/pull_request_template.md:
##########
@@ -9,3 +9,16 @@ Closes #<issue_number>
# Are there any user-facing changes?
# How was this patch tested?
+
+# Was this patch authored or co-authored using generative AI tooling?
+
+<!--
Review Comment:
Made the change, lmk what you think
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [AURON #2265] Add AI-assisted development guidance [auron]
Posted by "weiqingy (via GitHub)" <gi...@apache.org>.
weiqingy commented on code in PR #2387:
URL: https://github.com/apache/auron/pull/2387#discussion_r3575763959
##########
AGENTS.md:
##########
@@ -0,0 +1,71 @@
+<!--
+- 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.
+-->
+
+# Agent Guidelines for Apache Auron (Incubating)
+
+Entry point for AI coding agents and contributors making code changes.
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) before making changes. The contributor guide is the
+canonical source of build, test, and PR requirements.
+
+## Developer Documentation
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [README: Build from source](README.md#build-from-source)
+- [README: Run Spark Job with Auron Accelerator](README.md#run-spark-job-with-auron-accelerator)
+
+## Hard Rules
+
+- Use existing repository tooling and scripts only.
+- Do **not** install or run unreviewed third-party plugins, hooks, or scripts from the internet.
+- Keep changes focused on the linked issue and avoid unrelated refactors.
+- Do not commit code that fails formatting or relevant tests.
+
+## Before Committing
+
+At minimum, run formatting and the smallest relevant test coverage for your changes.
+
+```bash
+# check formatting
+./dev/reformat --check
+```
+
+Use the commands in [CONTRIBUTING.md](CONTRIBUTING.md#running-tests) for test selection.
+Common examples:
+
+```bash
+# run all tests
+./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --skiptests false
+
+# run Spark unit tests
+./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --sparktests true
+
+# run Rust tests
+cargo test
+```
+
+When opening a pull request, fill out every section of the
+[PR template](.github/pull_request_template.md).
+
+## AI Tooling Disclosure
+
+In the PR template section **Was this patch authored or co-authored using generative AI tooling?**:
+
+- If yes, include `Generated-by: <tool name and version>`
+- If no, write `No`
Review Comment:
Saw it now. Withdrawing this one. Nothing further from me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [AURON #2265] Add AI-assisted development guidance [auron]
Posted by "ShreyeshArangath (via GitHub)" <gi...@apache.org>.
ShreyeshArangath merged PR #2387:
URL: https://github.com/apache/auron/pull/2387
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [AURON #2265] Add AI-assisted development guidance [auron]
Posted by "weiqingy (via GitHub)" <gi...@apache.org>.
weiqingy commented on code in PR #2387:
URL: https://github.com/apache/auron/pull/2387#discussion_r3575652668
##########
AGENTS.md:
##########
@@ -0,0 +1,71 @@
+<!--
+- 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.
+-->
+
+# Agent Guidelines for Apache Auron (Incubating)
+
+Entry point for AI coding agents and contributors making code changes.
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) before making changes. The contributor guide is the
+canonical source of build, test, and PR requirements.
+
+## Developer Documentation
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [README: Build from source](README.md#build-from-source)
+- [README: Run Spark Job with Auron Accelerator](README.md#run-spark-job-with-auron-accelerator)
+
+## Hard Rules
+
+- Use existing repository tooling and scripts only.
+- Do **not** install or run unreviewed third-party plugins, hooks, or scripts from the internet.
+- Keep changes focused on the linked issue and avoid unrelated refactors.
+- Do not commit code that fails formatting or relevant tests.
+
+## Before Committing
+
+At minimum, run formatting and the smallest relevant test coverage for your changes.
+
+```bash
+# check formatting
+./dev/reformat --check
+```
+
+Use the commands in [CONTRIBUTING.md](CONTRIBUTING.md#running-tests) for test selection.
+Common examples:
+
+```bash
+# run all tests
+./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --skiptests false
+
+# run Spark unit tests
+./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --sparktests true
+
+# run Rust tests
+cargo test
+```
+
+When opening a pull request, fill out every section of the
+[PR template](.github/pull_request_template.md).
+
+## AI Tooling Disclosure
+
+In the PR template section **Was this patch authored or co-authored using generative AI tooling?**:
+
+- If yes, include `Generated-by: <tool name and version>`
+- If no, write `No`
Review Comment:
These two lines mirror the free-text prompt from the first commit — `b8f51db7b`'s template read *"If not, write: / No"* — but `6b785daaa` replaced that prompt with the `- [ ] Yes` / `- [ ] No` checkbox pair, and this section didn't move with it. Read literally, it now tells the reader to write the word `No` under a heading whose answer is a checkbox, which leaves both boxes unticked.
Worth a line because this is the one file in the repo whose entire purpose is to be followed literally by a coding agent, so a stale instruction here is followed rather than noticed.
Should this section pick up the checkbox wording now that the template has moved? Suggested wording, in case it helps:
```markdown
In the PR template section **Was this patch authored or co-authored using generative AI tooling?**:
- If generative AI tooling was used, tick `Yes` and add `Generated-by: <tool name and version>`.
- Otherwise, tick `No`.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [AURON #2265] Add AI-assisted development guidance [auron]
Posted by "ShreyeshArangath (via GitHub)" <gi...@apache.org>.
ShreyeshArangath commented on code in PR #2387:
URL: https://github.com/apache/auron/pull/2387#discussion_r3575690735
##########
AGENTS.md:
##########
@@ -0,0 +1,71 @@
+<!--
+- 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.
+-->
+
+# Agent Guidelines for Apache Auron (Incubating)
+
+Entry point for AI coding agents and contributors making code changes.
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) before making changes. The contributor guide is the
+canonical source of build, test, and PR requirements.
+
+## Developer Documentation
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [README: Build from source](README.md#build-from-source)
+- [README: Run Spark Job with Auron Accelerator](README.md#run-spark-job-with-auron-accelerator)
+
+## Hard Rules
+
+- Use existing repository tooling and scripts only.
+- Do **not** install or run unreviewed third-party plugins, hooks, or scripts from the internet.
+- Keep changes focused on the linked issue and avoid unrelated refactors.
+- Do not commit code that fails formatting or relevant tests.
+
+## Before Committing
+
+At minimum, run formatting and the smallest relevant test coverage for your changes.
+
+```bash
+# check formatting
+./dev/reformat --check
+```
+
+Use the commands in [CONTRIBUTING.md](CONTRIBUTING.md#running-tests) for test selection.
+Common examples:
+
+```bash
+# run all tests
+./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --skiptests false
+
+# run Spark unit tests
+./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --sparktests true
+
+# run Rust tests
+cargo test
+```
+
+When opening a pull request, fill out every section of the
+[PR template](.github/pull_request_template.md).
+
+## AI Tooling Disclosure
+
+In the PR template section **Was this patch authored or co-authored using generative AI tooling?**:
+
+- If yes, include `Generated-by: <tool name and version>`
+- If no, write `No`
Review Comment:
Isn't ticking and `Yes` an intuitive mapping? Does this need to be added?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [AURON #2265] Add AI-assisted development guidance [auron]
Posted by "cxzl25 (via GitHub)" <gi...@apache.org>.
cxzl25 commented on code in PR #2387:
URL: https://github.com/apache/auron/pull/2387#discussion_r3569636734
##########
.github/pull_request_template.md:
##########
@@ -9,3 +9,16 @@ Closes #<issue_number>
# Are there any user-facing changes?
# How was this patch tested?
+
+# Was this patch authored or co-authored using generative AI tooling?
+
+<!--
Review Comment:
I recommend removing these comments, because if these comments are not deleted during merge, they will be merged into the commit message.
Or we provide it in template
- [ ] Yes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@auron.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org