gearpump-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Weihua Jiang (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (GEARPUMP-12) Define and document the code style guide
Date Thu, 07 Apr 2016 01:50:25 GMT

    [ https://issues.apache.org/jira/browse/GEARPUMP-12?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15229513#comment-15229513
] 

Weihua Jiang commented on GEARPUMP-12:
--------------------------------------

For this task, what's our expected output?
1. A document guide? I guess this is needed, though if possible we'd better to make it consistent
and reuse other Scala projects' guides as much as possible (e.g. Spark).
2. A formatter (some .xml) integrated with popular IDEs (e.g. IntelliJ and Eclipse)? If we
have it, it will be great. But, I am not sure whether we can have it or not.
3. A standalone formatter at commandline or integrated with SBT? I doubt whether we need it
or not.


> Define and document the code style guide
> ----------------------------------------
>
>                 Key: GEARPUMP-12
>                 URL: https://issues.apache.org/jira/browse/GEARPUMP-12
>             Project: Apache Gearpump
>          Issue Type: Bug
>            Reporter: Sean Zhong
>            Assignee: Kam Kasravi
>            Priority: Minor
>
> We should define and document the code style guide, 
> Some references:
> 1. Spark style: https://github.com/databricks/scala-style-guide
> 2. Akka style: https://github.com/akka/akka/blob/master/CONTRIBUTING.md
> 3. Scala style: http://docs.scala-lang.org/style/



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

Mime
View raw message