[
https://issues.apache.org/jira/browse/BEAM-4394?focusedWorklogId=116769&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-116769
]
ASF GitHub Bot logged work on BEAM-4394:
----------------------------------------
Author: ASF GitHub Bot
Created on: 28/Jun/18 04:39
Start Date: 28/Jun/18 04:39
Worklog Time Spent: 10m
Work Description: swegner commented on a change in pull request #5797:
[BEAM-4394] Spotless Java everywhere
URL: https://github.com/apache/beam/pull/5797#discussion_r198705614
##########
File path: sdks/java/build-tools/src/main/resources/beam/checkstyle.xml
##########
@@ -117,7 +117,9 @@ page at http://checkstyle.sourceforge.net/config.html -->
</module>
<!-- Check that paragraph tags are used correctly in Javadoc. -->
- <!-- <module name="JavadocParagraph"/> -->
+ <!--
+ TODO(https://issues.apache.org/jira/browse/BEAM-4670): re-enable after
fixing after spotless
Review comment:
I believe your earlier commit [removes the checkstyle
check](https://github.com/apache/beam/pull/5797/commits/80fc678959c23de0ed88aa6f69d33d99756bf623#diff-86bc58f0541253b6301474bf7310a5e8L400
which previously banned this type of TODO.
The check banned having content tied to a TODO, i.e. `TODO(kenn): foobar`.
The check makes sense for usernames, but seems totally backwards for linking
bugs.
I'm happy keeping this format around. I'd also suggest shortening to simply
`TODO(BEAM-4670): ...`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 116769)
Time Spent: 2h 10m (was: 2h)
> Consider enabling spotless java format throughout codebase
> ----------------------------------------------------------
>
> Key: BEAM-4394
> URL: https://issues.apache.org/jira/browse/BEAM-4394
> Project: Beam
> Issue Type: New Feature
> Components: build-system
> Reporter: Kenneth Knowles
> Priority: Major
> Time Spent: 2h 10m
> Remaining Estimate: 0h
>
> "Spotless" can enforce - and automatically restore - automatic Java
> formatting. Whenever formatting is off, it tells a user the exact command to
> fix it.
> It isn't (just) about code layout, it is about automation. We have pretty
> strict style rules enforced by checkstyle. The most efficient way to fix up a
> file is with autoformat. But if the autoformat hits a bunch of irrelevant
> lines, that is annoying for a reviewer and obscures git blame.
> If we enforce autoformat all the time, then it makes sure that autoformatting
> a particular PR has minimal effects and is always safe to do.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
