From ad42b049aacff80b3d554e93847021b81593453e Mon Sep 17 00:00:00 2001 From: Jamison Lofthouse Date: Wed, 26 Oct 2016 17:20:55 -0600 Subject: [PATCH 1/2] Cleanup coding standards Cleared up a confusing statement about braces, fixed styling, etc.. --- docs/CODING_STANDARDS.md | 24 ++++++++++++++++-------- package.json | 6 +++--- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/docs/CODING_STANDARDS.md b/docs/CODING_STANDARDS.md index 8318a955..a3022a87 100644 --- a/docs/CODING_STANDARDS.md +++ b/docs/CODING_STANDARDS.md @@ -45,9 +45,8 @@ To avoid problems with non case sensitive file systems (Windows) only alphanumer Semicolons ---------- -There are [rebellious forces][isaac] that try to steal your semicolons from you. But make no mistake, our traditional culture is still [well and truly alive][hnsemicolons]. So follow the community, and use those semicolons! +There are rebellious forces that try to steal your semicolons from you. But make no mistake, our traditional culture is still [well and truly alive][hnsemicolons]. So follow the community, and use those semicolons! -[isaac]: community.html#isaac-schlueter [hnsemicolons]: http://news.ycombinator.com/item?id=1547647 Trailing whitespace @@ -130,7 +129,7 @@ If the block inside the curlys consists only of one statement the curlys may be return callback(err); ``` -However within one condition curlys must be used consistently. +However, curlys must be used consistently throughout the statement. *Right:* @@ -144,6 +143,15 @@ However within one condition curlys must be used consistently. } ``` +*Right:* + +```javascript + if (true) + console.log("Yes"); + else + console.log("Oh noo"); +``` + *Wrong:* ```javascript @@ -256,7 +264,7 @@ Constants Constants should be declared as regular variables or static class properties, using all uppercase letters. -Node.js / V8 actually supports mozilla's [const][const] extension, but unfortunately that cannot be applied to class members, nor is it part of any ECMA standard. +Node.js / V8 actually supports Mozilla's [const][const] extension, but unfortunately that cannot be applied to class members, nor is it part of any ECMA standard. *Right:* @@ -698,7 +706,7 @@ All classes and public API should be documented using [JSDuck annotations](https Commit messages --------------- -We try to adhere to https://github.com/blog/926-shiny-new-commit-styles and to a lesser extent http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html. +We try to adhere to https://github.com/blog/926-shiny-new-commit-styles and to a lesser extent http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html. Don't write `I fixed a bug` or `Fixed bug`, or even `Added a cool fix for bug`. Just write `Fix bug in wrop wraffles` or `Add feature flip floppers`, present tense. Branch Naming @@ -706,14 +714,14 @@ Branch Naming We follow the uni-repo approach so our source code is in one place. To work around some of the issues - for example looking at all PRs affecting a certain service - we prefix branches with the name of the service(s) the branch affects. -PR branch names, e.g. +PR branch names, e.g. “api-”, “ide-”, “multi-ide-vfs-sapi-” - + Checking for branch naming consistency is part of the review process and the teams responsibility. Use “all-” in case of doubt. E.g., https://github.com/c9/newclient/pull/12962/files affects redis schema code. - + Generally, releasing changes affecting several services is a smell so this can help you identify possible issues. You can now look for all PRs which made it in like so (api in this case): diff --git a/package.json b/package.json index 70759531..b7c362b4 100644 --- a/package.json +++ b/package.json @@ -70,7 +70,7 @@ "c9.ide.language.javascript.tern": "#0545a6385d", "c9.ide.language.javascript.infer": "#b9c2e4bdb8", "c9.ide.language.jsonalyzer": "#a0549e14ff", - "c9.ide.language.codeintel": "#0fe92d6f46", + "c9.ide.language.codeintel": "#957b840fff", "c9.ide.collab": "#a414999755", "c9.ide.local": "#9169fec157", "c9.ide.find": "#e632ecf4be", @@ -95,8 +95,8 @@ "c9.ide.imgeditor": "#612e75ef4f", "c9.ide.immediate": "#0b0ee744f9", "c9.ide.installer": "#2921efaf6d", - "c9.ide.language.python": "#9fba572b1a", - "c9.ide.language.go": "#6ce1c7a7ef", + "c9.ide.language.python": "#189b55135d", + "c9.ide.language.go": "#c58539fc05", "c9.ide.navigate": "#5d5707058c", "c9.ide.newresource": "#981a408a7b", "c9.ide.openfiles": "#2ae85a9e33", From 56f8a0127d4f8dc5447e13dd203c59b473136637 Mon Sep 17 00:00:00 2001 From: Jamison Lofthouse Date: Wed, 26 Oct 2016 18:59:37 -0600 Subject: [PATCH 2/2] Fix 'assignments' spelling error --- docs/CODING_STANDARDS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CODING_STANDARDS.md b/docs/CODING_STANDARDS.md index a3022a87..c7e8a49a 100644 --- a/docs/CODING_STANDARDS.md +++ b/docs/CODING_STANDARDS.md @@ -663,7 +663,7 @@ NOTE: It is sometimes useful to write a case statement which falls through to th Vertical alignment ------------------ -Vertically aligning asignments can improve readability but also makes it harder to maintain the code. The style should be avoided. +Vertically aligning assignments can improve readability but also makes it harder to maintain the code. The style should be avoided. *Right*: