@@ -43,9 +43,9 @@ the check-in process. These roles are:
43
43
44
44
Three basic types of branches may be included in the above repository:
45
45
46
- 1 . Master branch.
47
- 2 . Topic branches.
48
- 3 . Developer branches.
46
+ 1 . Master branch
47
+ 2 . Topic branches
48
+ 3 . Developer branches
49
49
50
50
Branches which do not fit into the above categories may be created and used
51
51
during the course of development for various reasons, such as large-scale
@@ -107,7 +107,7 @@ back into the master branch is to file a Pull Request. The contributions
107
107
should meet code, test, and commit message standards as described below,
108
108
and the pull request should include a completed author checklist, also
109
109
as described below. Pull requests may be assigned to specific team
110
- members when appropriate (e.g. to draw to a specific person's attention.)
110
+ members when appropriate (e.g. to draw to a specific person's attention).
111
111
112
112
Code review should take place using discussion features within the pull
113
113
request. When the reviewer is satisfied, they should add a comment to
@@ -130,26 +130,26 @@ settings. This is verified by the command line build.
130
130
JavaScript sources in Open MCT should:
131
131
132
132
* Use four spaces for indentation. Tabs should not be used.
133
- * Include JSDoc for any exposed API (e.g. public methods, constructors.)
133
+ * Include JSDoc for any exposed API (e.g. public methods, constructors).
134
134
* Include non-JSDoc comments as-needed for explaining private variables,
135
135
methods, or algorithms when they are non-obvious.
136
136
* Define one public class per script, expressed as a constructor function
137
137
returned from an AMD-style module.
138
138
* Follow “Java-like” naming conventions. These includes:
139
139
* Classes should use camel case, first letter capitalized
140
- (e.g. SomeClassName.)
140
+ (e.g. SomeClassName).
141
141
* 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).
148
148
* Avoid anonymous functions, except when functions are short (a few lines)
149
149
and/or their inclusion makes sense within the flow of the code
150
- (e.g. as arguments to a forEach call.)
150
+ (e.g. as arguments to a forEach call).
151
151
* Avoid deep nesting (especially of functions), except where necessary
152
- (e.g. due to closure scope.)
152
+ (e.g. due to closure scope).
153
153
* End with a single new-line character.
154
154
* Expose public methods by declaring them on the class's prototype.
155
155
* Within a given function's scope, do not mix declarations and imperative
@@ -234,7 +234,7 @@ Commit messages should:
234
234
 line of white space.
235
235
* Contain a short (usually one word) reference to the feature or subsystem
236
236
the commit effects, in square brackets, at the start of the subject line
237
- (e.g. ` [Documentation] Draft of check-in process ` )
237
+ (e.g. ` [Documentation] Draft of check-in process ` ).
238
238
* Contain a reference to a relevant issue number in the body of the commit.
239
239
* This is important for traceability; while branch names also provide this,
240
240
you cannot tell from looking at a commit what branch it was authored on.
@@ -250,17 +250,17 @@ Commit messages should:
250
250
Commit messages should not:
251
251
252
252
* Exceed 54 characters in length on the subject line.
253
- * Exceed 72 characters in length in the body of the commit.
253
+ * Exceed 72 characters in length in the body of the commit,
254
254
* Except where necessary to maintain the structure of machine-readable or
255
- machine-generated text (e.g. error messages)
255
+ machine-generated text (e.g. error messages).
256
256
257
257
See [ Contributing to a Project] ( http://git-scm.com/book/ch5-2.html ) from
258
258
Pro Git by Shawn Chacon and Ben Straub for a bit of the rationale behind
259
259
these standards.
260
260
261
261
## Issue Reporting
262
262
263
- Issues are tracked at https://github.com/nasa/openmct/issues
263
+ Issues are tracked at https://github.com/nasa/openmct/issues .
264
264
265
265
Issues should include:
266
266
@@ -284,7 +284,7 @@ Issue severity is categorized as follows (in ascending order):
284
284
285
285
The following check lists should be completed and attached to pull requests
286
286
when they are filed (author checklist) and when they are merged (reviewer
287
- checklist.)
287
+ checklist).
288
288
289
289
### Author Checklist
290
290
0 commit comments