[AVRO-1828] Add EditorConfig file

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.8.0
• Assignee: Niels Basjes Assign to me
• Reporter: Niels Basjes
• Created: 12/Apr/16 09:02
• Updated: 02/May/16 15:36
• Resolved: 02/May/16 15:36

Description

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:

1. We implement this for Avro at the root level with global defaults.
2. 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.
3. 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 files.

What do you guys think?

Issue Links

• blocks: AVRO-1838 Ensure Checkstyle enforces trailing spaces rule