[ 
https://issues.apache.org/jira/browse/OFBIZ-11251?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17156016#comment-17156016
 ] 

ASF subversion and git services commented on OFBIZ-11251:
---------------------------------------------------------

Commit 6f1907785deb26677325f56656952bd6228a5eb5 in ofbiz-framework's branch 
refs/heads/release18.12 from Aditya Sharma
[ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=6f19077 ]

Improved: Used 'checkstyle' linting tool (OFBIZ-11251)

Linting [1] is a software engineering practice which make the code
more readable and maintainable by improving its consistency and
avoiding potential programming mistakes.

Gradle provides a core plugin for the ‘checkstyle’ tool [2][3] which
provides such facility. The lint actions are triggered when running
‘gradle check’.

There are a lot reported errors that will need to be fixed
incrementally in the future. We ensure that new errors will not be
introduced by defining a global threshold of “allowed” errors
corresponding to the sum of errors currently found in the framework
and in the official plugins.

[1] https://en.wikipedia.org/wiki/Lint_(software)
[2] https://checkstyle.org/
[3] https://docs.gradle.org/current/userguide/checkstyle_plugin.html

Thanks Mathieu Lirzin for the contribution and Taher Alkhateeb & Jacques Le 
Roux for their feedback


> Use ‘checkstyle’ linting tool
> -----------------------------
>
>                 Key: OFBIZ-11251
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-11251
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: framework
>    Affects Versions: Trunk
>            Reporter: Mathieu Lirzin
>            Assignee: Aditya Sharma
>            Priority: Minor
>             Fix For: Upcoming Branch
>
>         Attachments: OFBIZ-11251-Use-checkstyle-linting-tool.patch
>
>
> Linting [1] is a software engineering practice which make the code
> more readable and maintainable by improving its consistency and
> avoiding potential programming mistakes.
> Gradle provides a core plugin for the ‘checkstyle’ tool [2][3] which
> provides such facility.  The lint actions are triggered when running
> ‘gradle check’.
> There are a lot reported errors that will need to be fixed
> incrementally in the future.  We ensure that new errors will not be
> introduced by defining a global threshold of “allowed” errors
> corresponding to the sum of errors currently found in the framework
> and in the official plugins.
> [1] https://en.wikipedia.org/wiki/Lint_(software)
> [2] https://checkstyle.org/
> [3] https://docs.gradle.org/current/userguide/checkstyle_plugin.html



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to