[
https://issues.apache.org/jira/browse/BIGTOP-1240?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13920396#comment-13920396
]
jay vyas edited comment on BIGTOP-1240 at 3/5/14 2:25 AM:
----------------------------------------------------------
FYI, here is what ive done to make it easier to create bigtop compliant
patches. I think this should/could go somewhere so its easy to add new
patches but maybe its obvious to everyone but me :)
- use intellij's groovy editor. It appears to default to spaces (instead of
tabs).
- set the "strip trailing spaces" option on save for all files
- set "Code style -> General -> Right margin" to 80
- set "Code style -> Groovy ->" to tabsize=4, indent=2, continuation_indent=4
- checked the "Code style -> Groovy " : "Ensure right margin is not exceeded"
box.
- reload all files at this point, so that settings take.
- Then use git to commit the patch in a single go, so that whole commit is
together.
- Then use mark grovers trick to create patches:
- git format-patch HEAD^..HEAD --stdout > BIGTOP-xxxx.patch
- Then to validate the patch:
- run "git am ../bigtop-jayunit100/BIGTOP-1221.4.intellij.patch " on a clean
bigtop head, and make sure you get now "whitespace" errors.
was (Author: jayunit100):
FYI, here is what ive done to make it easier to create bigtop compliant
patches. I think this should/could go somewhere so its easy to add new
patches but maybe its obvious to everyone but me :)
- use intellij's groovy editor. It appears to default to spaces (instead of
tabs).
- set the "strip trailing spaces" option on save for all files
- set "Code style -> General -> Right margin" to 80
- checked the "Code style -> Groovy " : "Ensure right margin is not exceeded"
box.
- reload all files at this point, so that settings take.
- Then use git to commit the patch in a single go, so that whole commit is
together.
- Then use mark grovers trick to create patches:
- git format-patch HEAD^..HEAD --stdout > BIGTOP-xxxx.patch
- Then to validate the patch:
- run "git am ../bigtop-jayunit100/BIGTOP-1221.4.intellij.patch " on a clean
bigtop head, and make sure you get now "whitespace" errors.
> Formatting Guidelines
> ---------------------
>
> Key: BIGTOP-1240
> URL: https://issues.apache.org/jira/browse/BIGTOP-1240
> Project: Bigtop
> Issue Type: Task
> Components: General
> Reporter: jay vyas
>
> We need to expand
> https://cwiki.apache.org/confluence/display/BIGTOP/How+to+Contribute with
> - formatting guidelines for groovy . groovy seems tricky to format, not sure
> what guidelines to follow.
> - Also bigtop has many other file types (bash, puppet, etc...) so probably
> good to outline expectations for those to, or at least link to references.
> - patch submission guidelines : if we want to use reviewboard or other review
> tools how we will use them, and in what cases.
> This will make minor nits easier : just reference the code formatting
> guidelines.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
