Skip to content

Commit 8e82a4a

Browse files
authored
[Docs] Edit for clarity
Around line 143, gave "constants" its own bullet point. Although it is a form of variable or field, it also forms a separate style element with a different guideline. It's also easier to find when skimming when separated - for new contributors who need to learn the style, and veteran contributors who are just double checking.
1 parent 7c78033 commit 8e82a4a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,12 @@ JavaScript sources in Open MCT should:
139139
* Classes should use camel case, first letter capitalized
140140
(e.g. SomeClassName.)
141141
* Methods, variables, fields, and function names should use camel case,
142-
first letter lower-case (e.g. someVariableName.) Constants
143-
(variables or fields which are meant to be declared and initialized
144-
statically, and never changed) should use only capital letters, with
145-
underscores between words (e.g. SOME_CONSTANT.)
146-
* File name should be the name of the exported class, plus a .js extension
147-
(e.g. SomeClassName.js)
142+
first letter lower-case (e.g. someVariableName.)
143+
* Constants (variables or fields which are meant to be declared and
144+
initialized statically, and never changed) should use only capital
145+
letters, with underscores between words (e.g. SOME_CONSTANT.)
146+
* File names should be the name of the exported class, plus a .js extension
147+
(e.g. SomeClassName.js).
148148
* Avoid anonymous functions, except when functions are short (a few lines)
149149
and/or their inclusion makes sense within the flow of the code
150150
(e.g. as arguments to a forEach call.)

0 commit comments

Comments
 (0)