mbutrovich commented on code in PR #27168:
URL: https://github.com/apache/datafusion/pull/27168#discussion_r4528091981
##########
AGENTS.md:
##########
@@ -68,7 +68,28 @@ RUST_BACKTRACE=1 cargo test --profile ci \
--features
avro,json,backtrace,extended_tests,recursive_protection,parquet_encryption
```
-For modified code identify local benchmarks(if any) and run them against
`main`. See [Benchmarks](benchmarks/README.md).
+For modified code identify local benchmarks(if any) and run them against
`main`, covering both well-predicted
+and poorly predicted input, plus one case the change does not touch. See
[Benchmarks](benchmarks/README.md)
+and [Review the
Performance](docs/source/contributor-guide/pr_review.md#review-the-performance).
+
+## Code Guidelines
+
+- A PR merges as one squashed commit titled with the PR title, so it should do
only what that title says. Put unrelated renames, reformatting, refactors, and
drive-by fixes in a
+ separate PR.
+- Default to no comment. Comment only what the code cannot say: invariants,
non-obvious constraints, and why
+ a choice that looks wrong is right. Do not restate the code or describe how
it changed. To explain a change
+ to reviewers, leave an inline PR review comment on the changed line instead.
New public items get
+ a rustdoc comment with a doctest example where appropriate, and refer to
other items with intra-doc
+ links such as `` [`SessionContext`] `` instead of plain names. See
Review Comment:
Agreed, let me reword it.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
