[logback-dev] [JIRA] (LOGBACK-1324) Bugs in code style specifications

QOS.CH (JIRA) noreply-jira at qos.ch
Sat Jul 8 00:16:00 CEST 2017


Tianyin Xu created LOGBACK-1324:
-----------------------------------

             Summary: Bugs in code style specifications
                 Key: LOGBACK-1324
                 URL: https://jira.qos.ch/browse/LOGBACK-1324
             Project: logback
          Issue Type: Bug
            Reporter: Tianyin Xu
            Assignee: Logback dev list


Hi,

I'm very much confused by the current code style specifications.

I checked out the code base on GitHub
https://github.com/qos-ch/logback
and the CONTRIBUTING.md specifies very detailed requirements for code style.

However, many of these requirements are not consistent with the Eclipse format file,  	codeStyle.xml (in the code base), nor the style of the actual code. 

For example, CONTRIBUTING.md specifies that
"S1. Use 2-space indents"

However, codeStyle.xml makes 4 space for indentation in Eclipse. 

I run CheckStyle on the existing code base and many of the lines are indented with tabs, e.g.,
Line 39, ./logback-core/src/main/java/ch/qos/logback/core/db/BindDataSourceToJNDIAction.java
Line 27, logback-core/src/main/java/ch/qos/logback/core/joran/action/ParamAction.java
(and many many others)

"S8 No extraneous new-lines. Only one line is necessary between elements." in CONTRIBUTING.md is also largely violated, such as 
Line
Line 155, logback-core/src/main/java/ch/qos/logback/core/AsyncAppenderBase.java
Line 188, logback-core/src/main/java/ch/qos/logback/core/OutputStreamAppender.java
(and many many others)

btw, are we using CheckStyle or something alike to enforce the code style right now?

Thanks!






--
This message was sent by Atlassian JIRA
(v7.3.1#73012)


More information about the logback-dev mailing list