beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <>
Subject [jira] [Work logged] (BEAM-4394) Consider enabling spotless java format throughout codebase
Date Thu, 28 Jun 2018 04:14:00 GMT


ASF GitHub Bot logged work on BEAM-4394:

                Author: ASF GitHub Bot
            Created on: 28/Jun/18 04:13
            Start Date: 28/Jun/18 04:13
    Worklog Time Spent: 10m 
      Work Description: swegner commented on a change in pull request #5797: [BEAM-4394] Spotless
Java everywhere

 File path: sdks/java/build-tools/src/main/resources/beam/checkstyle.xml
 @@ -241,20 +241,14 @@ page at -->
+    <!--
 Review comment:
   Same comment as above: if you plan on merging this, can you add a comment explaining why
it is necessary, and a tracking JIRA to re-enable it?

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:

Issue Time Tracking

    Worklog Id:     (was: 116762)
    Time Spent: 1h 40m  (was: 1.5h)

> Consider enabling spotless java format throughout codebase
> ----------------------------------------------------------
>                 Key: BEAM-4394
>                 URL:
>             Project: Beam
>          Issue Type: New Feature
>          Components: build-system
>            Reporter: Kenneth Knowles
>            Priority: Major
>          Time Spent: 1h 40m
>  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

View raw message