This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-fury.git
The following commit(s) were added to refs/heads/main by this push:
new f892802f docs: Use perf type when pr has performance impact. (#1474)
f892802f is described below
commit f892802f6d7b6d28134ebc77c47f887f9089bf36
Author: LiangliangSui <[email protected]>
AuthorDate: Sun Apr 7 12:33:09 2024 +0800
docs: Use perf type when pr has performance impact. (#1474)
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]>
---
CONTRIBUTING.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 22115e0d..b7558aff 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
