This is an automated email from the ASF dual-hosted git repository.
ethanfeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new 4d7fc66c7 [CELEBORN-1091] Update docs about how to use error-prone
plugin in IDEA
4d7fc66c7 is described below
commit 4d7fc66c73cb66953abf9a7f48c2857da58b0c09
Author: SteNicholas <[email protected]>
AuthorDate: Wed Oct 25 21:50:36 2023 +0800
[CELEBORN-1091] Update docs about how to use error-prone plugin in IDEA
### What changes were proposed in this pull request?
`CONTRIBUTING.md` introduces how to use Error Prone in IntelliJ IDEA.
### Why are the changes needed?
Error Prone is a static analysis tool for Java that catches common
programming mistakes at compile-time. Starting from version 0.4.0, the Celeborn
project supports augment the compiler’s type analysis using Error Prone. It's
better to provide a detailed guide on how to eliminate classes of serious bugs
from entering code in the Celeborn project using Error Prone plugin in IntelliJ
IDEA.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
No.
Closes #2047 from SteNicholas/CELEBORN-1091.
Authored-by: SteNicholas <[email protected]>
Signed-off-by: mingji <[email protected]>
---
CONTRIBUTING.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0afd10fd2..75aa28fbd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -38,3 +38,10 @@ There are already some further improvements on the schedule
and welcome to conta
### Adding RPC Messages
When you add new RPC message, it's recommended to follow raw PB message case,
for example
`RegisterWorker` and `RegisterWorkerResponse`. The RPC messages will be
unified into raw PB messages eventually.
+
+### Using Error Prone
+Error Prone is a static analysis tool for Java that catches common programming
mistakes at compile-time.
+
+To add the Error Prone plugin in IntelliJ IDEA, start the IDE and find the
Plugins dialog. Browse Repositories, choose Category: Build, and find the
Error-prone plugin. Right-click and choose 'Download and install'. The IDE will
restart after you’ve exited these dialogs.
+
+Allows to build projects using Error Prone Java compiler to catch common Java
mistakes at compile-time. To use the compiler, go to 'File |
Settings/Preferences | Build, Execution, Deployment | Compiler | Java Compiler'
and select 'Javac with error-prone' in 'Use compiler' box.
