[jbossts-issues] [JBoss JIRA] (JBTM-3300) Enable the checkstyle plugin on as many non Arjuna modules as makes sense

[Michael Musgrove (Jira)]

    [ https://issues.redhat.com/browse/JBTM-3300?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14048671#comment-14048671 ] 

Michael Musgrove commented on JBTM-3300:
----------------------------------------

Rejecting in favour of the following policy that we've been following since 2005:

- if you add a new file it MUST adhere to our checkstyle ruleset
- if you change a file (in a non trivial way) you are allowed (MAY) to reformat the code to conform to our checkstyle ruleset. If you choose not to reformat it then you SHOULD, where possible, try to follow the same style that's already in use for that file.

We will add a build property called checkstyle that you can pass to the compilation. Note that we need our own property because you cannot override a plugin property that is already set in the plugin configuration section (ie -Dcheckstyle.skip=false does not work).

We will also update the "New Pull Request" github message to reference this policy.

> Enable the checkstyle plugin on as many non Arjuna modules as makes sense
> -------------------------------------------------------------------------
>
>                 Key: JBTM-3300
>                 URL: https://issues.redhat.com/browse/JBTM-3300
>             Project: JBoss Transaction Manager
>          Issue Type: Task
>          Components: LRA, REST, TxBridge, XTS
>    Affects Versions: 5.10.4.Final
>            Reporter: Michael Musgrove
>            Assignee: Michael Musgrove
>            Priority: Optional
>             Fix For: 5.next
>
>
> The checkstyle plugin is intended for use on new files but it is currently disabled. We should enable for as many of our modules as possible.
> Arjuna modules should be precluded.
> I am not sure if we want to enable it for STM.
> Note that we use the WildFly checkstyle rule set (https://github.com/wildfly/wildfly-checkstyle-config/tree/master/src/main/resources/wildfly-checkstyle).



--
This message was sent by Atlassian Jira
(v7.13.8#713008)