sthope/gitea_templates
Template
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

code style 7.2: add .editorconfig info #90 (#96)

Browse Source 
Adds an explanation of using .editorconfig in the project root for IDE code style standardization on a project.
This commit is contained in:
Cory Robinson 2017-09-07 10:18:35 -07:00 committed by Vahid Panjganj
parent c22597c84f
commit 1f7c0ee0b3
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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.