Skip to content

Commit

Permalink
docs: Use perf type when pr has performance impact. (apache#1474)
Browse files Browse the repository at this point in the history
When PR has an impact on Fury performance, it is recommended to use perf
type and provide benchmark data in the PR description.

Signed-off-by: LiangliangSui <[email protected]>
  • Loading branch information
LiangliangSui authored Apr 7, 2024
1 parent d28b14d commit f892802
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ For example, here are good PR titles:
- fix(c++): blablabla
- chore(python): remove useless yyy file

If the submitted PR affects the performance of Fury, we strongly recommend using the perf type,
and need to provide benchmark data in the PR description. For how to run the benchmark,
please check [Fury Java Benchmark](https://github.com/apache/incubator-fury/blob/main/java/benchmark/README.md).

For more details, please check [pr-lint.yml](./.github/workflows/pr-lint.yml).

## Testing
Expand Down

0 comments on commit f892802

Please sign in to comment.