Docs: Clarify scope of the style guides #139

dmethvin · 2016-05-12T01:05:59Z

arschmitz · 2016-05-12T01:51:22Z

pages/style-guide.md


-Our style guides aim to make the code bases appear as if they were written by one precise punctilious programmer, rather than a cacophony of competing coders. As with many aspects of coding and writing, there can be differences of opinion about the best style. Contentious issues like "spaces versus tabs" or "semicolons or not" distract from the goal of writing code that works. Most project contributors have a slightly different personal coding style, but we all use the jQuery style when contributing to jQuery projects.
+Long term, we would like to have formatting automatically done by the build process, so that the resulting code would always follow the style guide. We have taken a few steps in that direction. For example, our projects contain an [EditorConfig file](http://editorconfig.org) that many programming editors can use to enforce the space and tab rules. Our [JSHint](http://www.jshint.com/about/) configuration checks for common style _faux pas_ such as trailing spaces on a line, or using a variable before it is defined. Some projects use [ESLint]() or [JSCS]() to do more exensive style checks.


links for ESLint and JSCS are missing here

Long term, we would like to have formatting automatically done by the build process

esformatter, also used by standard-format, can provide that. JSCS with autofixing as well (afaik to a lesser degree though). Since those tools exist and aren't used in our build process (right?), I wonder if it really makes sense to mention that here as a goal.

Docs: Clarify scope of the style guides

8ae7c6e

jquerybot added the CLA: Valid label May 12, 2016

dmethvin mentioned this pull request May 12, 2016

Adopt standard module (for new projects) #138

Closed

arschmitz reviewed May 12, 2016
View reviewed changes

dmethvin closed this in e701b2c Jul 27, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Clarify scope of the style guides #139

Docs: Clarify scope of the style guides #139

dmethvin commented May 12, 2016

arschmitz May 12, 2016

jzaefferer May 12, 2016


		Our style guides aim to make the code bases appear as if they were written by one precise punctilious programmer, rather than a cacophony of competing coders. As with many aspects of coding and writing, there can be differences of opinion about the best style. Contentious issues like "spaces versus tabs" or "semicolons or not" distract from the goal of writing code that works. Most project contributors have a slightly different personal coding style, but we all use the jQuery style when contributing to jQuery projects.
		Long term, we would like to have formatting automatically done by the build process, so that the resulting code would always follow the style guide. We have taken a few steps in that direction. For example, our projects contain an [EditorConfig file](http://editorconfig.org) that many programming editors can use to enforce the space and tab rules. Our [JSHint](http://www.jshint.com/about/) configuration checks for common style _faux pas_ such as trailing spaces on a line, or using a variable before it is defined. Some projects use [ESLint]() or [JSCS]() to do more exensive style checks.

Docs: Clarify scope of the style guides #139

Docs: Clarify scope of the style guides #139

Conversation

dmethvin commented May 12, 2016

arschmitz May 12, 2016

Choose a reason for hiding this comment

jzaefferer May 12, 2016

Choose a reason for hiding this comment