A while back I did a some preliminary work on KAFKA-2423: Introduce
ScalaStyle. There is a pull request here:
https://github.com/apache/kafka/pull/560. The important content for review
is the rule set defined in scalastyle_config.xml.

I know complete consensus on something like this may not be feasible, but I
think there is value in defining some basic style rules to expedite the
patch review process and improve code readability, clarity, and quality.
The Java Checkstyle rules added to Kafka have worked well, and I think
having similar rules for Scala are important.

If there are no major oppositions to the rules, I would like to first:

   1. Add an optional build task to check the code for ScalaStyle rule
   violations
   2. Fix the very basic violations (whitespace, line length, etc)
   3. Over time fix more impactful violations

During this time period we can also identify if the rules are too strict,
annoying or need to be adjusted. Once the issues are fixed we can then run
ScalaStyle checks as a part of the build to be sure no new violations
occur.

Do we agree these checks would be valuable? Do the rules and approach
proposed in my pull request seam reasonable?

Thanks,
Grant
-- 
Grant Henke
Software Engineer | Cloudera
gr...@cloudera.com | twitter.com/gchenke | linkedin.com/in/granthenke

Reply via email to