document requirements for credits fields

Signed-off-by: Chris Malley <[email protected]>
phetsims · Oct 31, 2018 · d349c05 · d349c05
1 parent ee3eaab
commit d349c05
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/js/CreditsNode.js b/js/CreditsNode.js
@@ -59,30 +59,44 @@ define( function( require ) {
       tagName: 'h2',
       innerContent: creditsTitleString
     } ) );
+
+    // Primary lead designer should be listed first, followed by contributing designers in alphabetical order.
     if ( credits.leadDesign ) {
       var designString =  StringUtils.format( creditsLeadDesignString, '\u202a' + credits.leadDesign + '\u202c' );
       children.push( new RichText( designString, _.extend( { innerContent: designString }, multiLineTextOptions ) ) );
     }
+
+    // Primary developer should be listed first, followed by contributing developers in alphabetical order.
     if ( credits.softwareDevelopment ) {
       var developmentString = StringUtils.format( creditsSoftwareDevelopmentString, '\u202a' + credits.softwareDevelopment + '\u202c' );
       children.push( new RichText( developmentString, _.extend( { innerContent: developmentString }, multiLineTextOptions ) ) );
     }
+
+    // In alphabetical order
     if ( credits.team ) {
       var teamString = StringUtils.format( creditsTeamString, '\u202a' + credits.team + '\u202c' );
       children.push( new RichText( teamString, _.extend( { innerContent: teamString }, multiLineTextOptions ) ) );
     }
+
+    // In alphabetical order
     if ( credits.contributors ) {
       var contributorsString = StringUtils.format( creditsContributorsString, '\u202a' + credits.contributors + '\u202c' );
       children.push( new RichText( contributorsString, _.extend( { innerContent: contributorsString }, multiLineTextOptions ) ) );
     }
+
+    // In alphabetical order
     if ( credits.qualityAssurance ) {
       var qualityAssuranceString = StringUtils.format( creditsQualityAssuranceString, '\u202a' + credits.qualityAssurance + '\u202c' );
       children.push( new RichText( qualityAssuranceString, _.extend( { innerContent: qualityAssuranceString }, multiLineTextOptions ) ) );
     }
+
+    // In alphabetical order
     if ( credits.graphicArts ) {
       var graphicArtsString = StringUtils.format( creditsGraphicArtsString, '\u202a' + credits.graphicArts + '\u202c' );
       children.push( new RichText( graphicArtsString, _.extend( { innerContent: graphicArtsString }, multiLineTextOptions ) ) );
     }
+
+    // In alphabetical order
     if ( credits.soundDesign ) {
       var soundDesignString = StringUtils.format( creditsSoundDesignString, '\u202a' + credits.soundDesign + '\u202c' );
       children.push( new RichText( soundDesignString, _.extend( { innerContent: soundDesignString }, multiLineTextOptions ) ) );