TisonKun edited a comment on issue #1049: ZOOKEEPER-3475 Enable Checkstyle 
configuration on zookeeper-server
URL: https://github.com/apache/zookeeper/pull/1049#issuecomment-520634570
 
 
   With read comments above, I'd like to propose group rules in different 
concerns into different issue/pull request. Initially on the mailing list we 
reach a consensus on enabling checkstyle configuration per package/module 
instead of per rules but as described above different type of rules need 
different attention. Basically, it would be
   
   A basic checkstyle rules, that is, the same as current 
`checkstyle-strict.xml` excludes *Names rules, JavaDoc rules and LineBreak. 
Details as below.
   
   - A new JIRA issue to track a revisit of *Names rules as well as variable 
visibility. The leverage is between backward compatibility to strict 
visibility. For example `public static` should be ALL_CAPS ideally but for 
backward compatibility we should retain; while a series of `(default) static` 
is occasionally package-private but semantically should be `private static`.
   
   - JavaDoc is not just about checkstyle. As filed in ZOOKEEPER-3469 we need a 
dedicated pass for reviewing changes in JavaDoc regard the changes in 
documentation scope as well.
   
   - LineBreak is suppressed as well. There is not a general ideal how to break 
a line and it requires a discussion on code style in Flink community[1]. I 
would prefer suppress it at least for now or even we reach a consensus that we 
don't need it.
   
   - Fair enough, log format deserves a JIRA issue although it might out of the 
scope here.
   
   And consequently, the basic checkstyle configuration focuses on whitespaces, 
imports, operators on a new line, redundant or out-of-order modifiers, TODO 
comments, and if/else also with curly.
   
   It's ok to me that this pull request as a prototype on bringing checkstyle 
to zookeeper-server and a total rebase require one or two days doesn't inflict 
too much. It is more important to see where our community decide to go.
   
   [1] 
https://lists.apache.org/thread.html/609112aa8d0a0d3260bfca4f34ca405f39e2f44bf6bcba010068266e@%3Cdev.flink.apache.org%3E

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to