[jbossts-issues] [JBoss JIRA] (JBTM-989) Consider using a common code style throughout Narayana

Tom Jenkinson (JIRA) jira-events at lists.jboss.org
Mon Mar 12 07:36:48 EDT 2012

    [ https://issues.jboss.org/browse/JBTM-989?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12675911#comment-12675911 ] 

Tom Jenkinson commented on JBTM-989:

I think this should apply to all modules hanging off the root narayana pom. The following statements should be taken assuming we do decide to reformat:

I don't think we have any modules that fulfil the property of being isolated to the single developer degree, some could be at the moment but in the long term are very unlikely to be. Incubator style modules - e.g. STM - where there is a single developer working on it at the moment, probably don't need the formatting *right now*, but before they become .Final and as such become community supported I believe they would need to follow the consistent style as the developer has contributed that work to the public domain and adhering to a formatting will make it easier for other developers to then submit patches/pull reqs.

Also, a note to the above statement, if we don't like the AS7 style potentially we could develop our own (negating one positive which would is consistency with AS7). I am of the opinion of where I don't really mind what the code looks like (within reason) so long as it all looks the same?
> Consider using a common code style throughout Narayana
> ------------------------------------------------------
>                 Key: JBTM-989
>                 URL: https://issues.jboss.org/browse/JBTM-989
>             Project: JBoss Transaction Manager
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>    Affects Versions: 5.0.0.M1
>            Reporter: Paul Robinson
>            Assignee: Tom Jenkinson
>             Fix For: 5.0.0.M2
> I think we should consider using a common code style throughout the TS project. The benefits of doing this are as follows:
> # You can automate code formatting. This is a real productivity boost as you can type away, thinking about your code, rather than the style. When you hit save, or trigger it directly, the code is formatted.
> ## This is not possible without a project wide code style as you too frequently re-format code that needs to stay in someone else's personal style. You can't commit this changed code as; a) it may annoy the "owner" and b) it results in a change that can't be diffed (every line may be changed). 
> # We get consistency over the whole project, making it easier to read code written by others.
> # We have to do this anyway for code we maintain inside the JBossAS project as the project refuses to build if it doesn't adhere to their style.
> Personally, I like the style I've used for the last 10 years. I find it harder to read code that is not in this style. Hence I can understand why people may object to changing their style. However, this is  the very reason why a common style is beneficial. You can get used to a new style and once you do, the entire project will be styled in the way that you are used to. Providing the style is sensible, I would much rather use a style consistent across the projects I work on. I'm happy for that style to be different to my current style.
> As I stated above JBossAS mandates a style at build time. I don't particularly like the style (braces should occupy their own line, IMO) but I'm happy to go with this one if it becomes the Narayana standard style.
> I think we should also break the build for violations. This should prevent mistakes making their way into SVN. 

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


More information about the jbossts-issues mailing list