You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "zhuqi-lucas (via GitHub)" <gi...@apache.org> on 2026/03/26 09:25:11 UTC
[PR] docs: Add explicit fmt and clippy commands to AGENTS.md [datafusion]
zhuqi-lucas opened a new pull request, #21171:
URL: https://github.com/apache/datafusion/pull/21171
## Which issue does this PR close?
N/A - minor documentation improvement.
## Rationale for this change
The "Before Committing" section in `AGENTS.md` (symlinked as `CLAUDE.md`) tells agents to follow the contributor guide but does not list the concrete commands. Agents may skip `cargo fmt` or `cargo clippy` and submit PRs with formatting/lint errors that fail CI.
## What changes are included in this PR?
Adds explicit `cargo fmt --all` and `cargo clippy` commands that agents MUST run before committing, along with a pointer to the full `./dev/rust_lint.sh` suite.
## Are these changes tested?
Documentation only — no code changes.
## Are there any user-facing changes?
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add explicit fmt and clippy commands to AGENTS.md [datafusion]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #21171:
URL: https://github.com/apache/datafusion/pull/21171#discussion_r2993520871
##########
AGENTS.md:
##########
@@ -15,6 +15,24 @@ Before committing any changes, you MUST follow the instructions in
and ensure the required checks listed there pass. Do not commit code that
fails any of those checks.
+At a minimum, you MUST run and fix any errors from these commands before
+committing:
+
+```bash
+# Format code
+cargo fmt --all
+
+# Lint (must pass with no warnings)
Review Comment:
The recommended clippy invocation here doesn’t match the repository’s CI lint configuration: `ci/scripts/rust_clippy.sh` runs clippy with `--workspace` and a specific feature set ("avro,integration-tests,extended_tests"), not `--all-features`. Since this section uses MUST language, please either align the documented command with the CI clippy flags (or point readers to `./ci/scripts/rust_clippy.sh` / `./dev/rust_lint.sh` for the exact CI-equivalent command) or explicitly call out that `--all-features` is intentionally stricter/different than CI.
```suggestion
# Lint (must pass with no warnings)
# Note: this runs clippy with --all-features, which is intentionally stricter than CI.
# To match CI exactly, use ./dev/rust_lint.sh as shown below.
```
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add explicit fmt and clippy commands to AGENTS.md [datafusion]
Posted by "Dandandan (via GitHub)" <gi...@apache.org>.
Dandandan commented on code in PR #21171:
URL: https://github.com/apache/datafusion/pull/21171#discussion_r2993599119
##########
AGENTS.md:
##########
@@ -15,6 +15,24 @@ Before committing any changes, you MUST follow the instructions in
and ensure the required checks listed there pass. Do not commit code that
fails any of those checks.
+At a minimum, you MUST run and fix any errors from these commands before
+committing:
+
+```bash
+# Format code
+cargo fmt --all
Review Comment:
Ah yeah I was suggesting this in https://github.com/apache/datafusion/pull/20970#discussion_r2944322744
At least Claude will only read AGENTS.md at start so you have to put it there (for now).
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add explicit fmt and clippy commands to AGENTS.md [datafusion]
Posted by "zhuqi-lucas (via GitHub)" <gi...@apache.org>.
zhuqi-lucas commented on PR #21171:
URL: https://github.com/apache/datafusion/pull/21171#issuecomment-4133140472
Thanks @Dandandan for review, merged now.
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add explicit fmt and clippy commands to AGENTS.md [datafusion]
Posted by "zhuqi-lucas (via GitHub)" <gi...@apache.org>.
zhuqi-lucas merged PR #21171:
URL: https://github.com/apache/datafusion/pull/21171
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org