[jira] [Created] (FLINK-1612) Add guidelines to avoid duplicate class names and more JavaDoc for new addition

[Shang Yuanchun (Jira)]

Henry Saputra created FLINK-1612:
------------------------------------

             Summary: Add guidelines to avoid duplicate class names and more JavaDoc for new addition
                 Key: FLINK-1612
                 URL: https://issues.apache.org/jira/browse/FLINK-1612
             Project: Flink
          Issue Type: Improvement
          Components: website, Documentation
            Reporter: Henry Saputra


Per discssions in dev@ list would like to add extra guidelines to code style on how to contribute in Flink website:
-) Add guide to avoid same class names, even though in different packages, in non client facing (eg: Scala vs Java) APIs code. This will allow easier way for new contributors to trace and understand the internal of Flink.
-) Add guide to make sure new Java and Scala classes have JavaDoc explaining why the are they added and how it relates to existing code and flows.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)