avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Niels Basjes (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (AVRO-1828) Add EditorConfig file
Date Mon, 02 May 2016 13:52:12 GMT

     [ https://issues.apache.org/jira/browse/AVRO-1828?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Niels Basjes updated AVRO-1828:
    Status: Patch Available  (was: Open)

I found that the Checkstyle configuration doesn't seem to work right. Almost none of the Java
code is validated.
I did an experimental change using this as a guide https://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html
This caused a lot of new errors to surface.
I say we should do this, yet my proposal is to make that a separate Jira.

I I propose we commit the last patch I posted, then make a new Jira for Checkstyle.

[~rdblue] What do you think?

> Add EditorConfig file
> ---------------------
>                 Key: AVRO-1828
>                 URL: https://issues.apache.org/jira/browse/AVRO-1828
>             Project: Avro
>          Issue Type: Improvement
>    Affects Versions: 1.8.0
>            Reporter: Niels Basjes
>            Assignee: Niels Basjes
>         Attachments: AVRO-1828-2016-04-28-ratfix.patch, AVRO-1828-2016-04-28.patch
> I was working with Apache Flink last week and they recently implemented http://editorconfig.org/
( see here https://github.com/apache/flink/blob/master/.editorconfig )
> Essentially this is a very simple config file that instructs a great many editors to
adhere to the main coding standard choices (things like character encoding, tabs v.s. spaces
, newlines, etc) for a specific project on a per file type basis.
> When someone opens the project in a intelliJ then this will automatically use these settings.
> Proposal: 
> # We implement this for Avro at the root level with global defaults.
> # We implement a specific file per language. I think we should start with the top level
scripting (like build.sh and pom.xml) and Java as the first language.
> # We fix the violations of this standard in a single commit per language. Note that if
we don't fix those violations then later commits will be 'harder' to keep clean (you will
see a lot of unrelated changes) because the IDEs will 'enforce' the standard on all touched
> What do you guys think?

This message was sent by Atlassian JIRA

View raw message