Skip to content

Commit

Permalink
code style 7.2: add .editorconfig info elsewhencode#90 (elsewhencode#96)
Browse files Browse the repository at this point in the history
Adds an explanation of using .editorconfig in the project root for IDE code style standardization on a project.
  • Loading branch information
crobinson42 authored and Vahid Panjganj committed Sep 7, 2017
1 parent c22597c commit 1f7c0ee
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,11 @@ Having a good guideline for creating commits and sticking to it makes working wi
<a name="enforcing-code-style-standards"></a>
### 7.2 Enforcing code style standards
* Use a [.editorconfig](http://editorconfig.org/) file which helps developers define and maintain consistent coding styles between different editors and IDEs on the project.
_Why:_
> 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.
* Have your editor notify you about code style errors. Use [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) and [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) with your existing ESLint configuration. [read more...](https://github.com/prettier/eslint-config-prettier#installation)
* Consider using Git hooks.
Expand Down

0 comments on commit 1f7c0ee

Please sign in to comment.