Add documentation about performance PRs, add (TBD) section on feature criteria #12372
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alamb
changed the title
alamb
commented
Sep 7, 2024
| 2. Is the code clear, and fits the style of the existing codebase? | ||
|
|
||
| ## Performance Improvements |
There was a problem hiding this comment.
This is the new content
|
|
||
| Please ensure any issues you raise contains a rationale and suggested alternative -- it is frustrating to be told "don't do it this way" without any clear reason or alternate provided. | ||
|
|
||
| Some things to specifically check: | ||
|
|
||
| 1. Is the feature or fix covered sufficiently with tests (see `Test Organization` below)? | ||
| 1. Is the feature or fix covered sufficiently with tests (see the [Testing](testing.md) section)? |
There was a problem hiding this comment.
added link (there is actually no Testing Organization section anymore below)
alamb
changed the title
comphead
reviewed
Sep 7, 2024
| - [System level SQL Benchmarks](https://github.com/apache/datafusion/tree/main/benchmarks) | ||
| - Microbenchmarks such as those in [functions/benches](https://github.com/apache/datafusion/tree/main/datafusion/functions/benches) | ||
|
|
||
| If there is no suitable existing benchmark, you can create a new one. It helps |
There was a problem hiding this comment.
This is a good point, very often reviewing PRs we have to ask showing the actual performance benefit with existing benches or other performance tests
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Related to #12357
Rationale for this change
I think there is some "common knowledge" that is not explicitly written down anywhere
Specifically, that performance improvements should be accompanied by benchmark results (most recently this came up in #12270)
What changes are included in this PR?
Note I am not trying to change anything, only document the current reality.
Are these changes tested?
by doc CI
Are there any user-facing changes?
Docs