From 1f7c0ee0b30d3d9909686bd2a1e35951c94f9453 Mon Sep 17 00:00:00 2001 From: Cory Robinson Date: Thu, 7 Sep 2017 10:18:35 -0700 Subject: [PATCH] code style 7.2: add .editorconfig info #90 (#96) Adds an explanation of using .editorconfig in the project root for IDE code style standardization on a project. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 2318349..48a3d5d 100644 --- a/README.md +++ b/README.md @@ -461,6 +461,11 @@ Having a good guideline for creating commits and sticking to it makes working wi ### 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.