You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+5-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,15 @@ or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).
8
8
# Coding Standard
9
9
10
10
* Use spaces instead of tab characters, a tab should be 4 spaces.
11
-
* Class names should be camel case (e.g. AvatarWidget), with no underscores "_".
12
-
* Class member fields should be camel case and begin with "m_" (e.g. m_MemberVariable), no other underscores allowed in the variable name.
13
-
* Static class member fields should camel case and begin with "sm_", no other underscores allowed in the variable name.
11
+
* Class names should be PascalCase (e.g. SpeechToText), with no underscores "_".
12
+
* Class member fields should be camel case and begin with "_" (e.g. _memberVariable), no other underscores allowed in the variable name.
14
13
* Structures should follow the same naming standards as classes.
15
14
* No K&R coding style. Braces {} should be on their own line, aligned with the parent statement.
16
15
* No public variables, always use public properties unless there is no other workaround.
17
-
* Properties should be camel case, no underscores. (e.g. public bool IsReady { get; set; })
18
-
* Constants should be all upper case (e.g. static readonly string CONFIG_FILE = "/Config.json"). This includes enumerations.
16
+
* Properties should be camel case, no underscores (e.g. public bool IsReady { get; set; }).
17
+
* Constants should be all PascalCase (e.g. static readonly string ConfigFile = "/Config.json"). This includes enumerations.
19
18
* All public functions and types of all classes should be fully documented using the XML comment style.
20
-
* Local variables should begin with lower-case character, then camel case after the first character. (e.g. var widgetConnector = new WidgetConnector())
19
+
* Local variables should be camel case. (e.g. var speechToText = new SpeechToText())
21
20
* Use protected on variables & functions only if you plan to inherit from the class or there is a good chance we will need to be polymorphic.
22
21
* Use region to separate parts of a class based on functionality.
0 commit comments