[jira] [Created] (HUDI-354) Introduce stricter comment and code style validation rules

["vinoyang (Jira)" <ji...@apache.org>]

vinoyang created HUDI-354:
-----------------------------

             Summary: Introduce stricter comment and code style validation rules
                 Key: HUDI-354
                 URL: https://issues.apache.org/jira/browse/HUDI-354
             Project: Apache Hudi (incubating)
          Issue Type: Task
            Reporter: vinoyang


This is an umbrella issue used to track apply some stricter comment and code style validation rules for the whole project. The rules list below:

1) All public classes must add class-level comments;
2) All comments must end with a clear "."
3) In the import statement of the class, clearly distinguish (by blank lines) the import of Java SE and the import of non-java SE. Currently, I saw at least two projects(Spark and Flink) that implement this rule. Flink implements stricter rules than Spark. It is divided into several blocks from top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE import -> static import), each block are sorted according to the natural sequence of letters;
4) Reconfirm the method and whether the comment is consistency;

Each project sub-module mappings to one subtask.

How to find all the invalidated points?

TBD.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)