Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Document whitespace convention #356

Merged
merged 1 commit into from
Dec 14, 2016

Conversation

paulerickson
Copy link
Contributor

EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems. -- http://editorconfig.org/

This one says "files in this project should be utf-8 encoded, with two spaces per indent level, and no trailing whitespace except a line feed character at the end of each line."

IntelliJ and Eclipse detect these settings out of the box; vim needs a plugin.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 39.149% when pulling 258844e on paulerickson:master into f78541f on UW-Madison-DoIT:master.

Copy link
Contributor

@apetro apetro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A hearty 👍.

There'd be value in going further, in Travis-CI enforcing the conventions, in adopting a more comprehensive code style guide (I think Google Style is the style to adopt).

This is a fine step forward, can iterate from here towards better.

@paulerickson paulerickson merged commit 3cd040a into uPortal-Attic:master Dec 14, 2016
@apetro apetro added this to the 3.0.3 milestone Dec 20, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants