Fixes for usability, clarity, and documentation

https://software.topcoder.com/review/actions/ViewProjectDetails?method=viewProjectDetails&pid=30070258

Author: jmgasper

.eslintrc

@@ -43,5 +43,6 @@
             }
         ],
         "max-lines": 0,
+        "max-statements": 0
     }
 }

README.md

@@ -43,7 +43,12 @@ The following config parameters are supported, they are defined in `config/defau
 |GITLAB_API_BASE_URL| the URL for gitlab host| defaults to `https://gitlab.com`|
 |PAID_ISSUE_LABEL|the label name for paid, should be one of the label configured in topcoder x ui|'tcx_Paid'|
 |FIX_ACCEPTED_ISSUE_LABEL|the label name for fix accepted, should be one of the label configured in topcoder x ui|'tcx_FixAccepted'|
+|ASSIGNED_ISSUE_LABEL| the label name for assigned, should be one of the label configured in topcoder x ui| 'tcx_Assigned'|
+|OPEN_FOR_PICKUP_ISSUE_LABEL| the label name for open for pickup, should be one of the label configured in topcoder x ui| 'tcx_OpenForPickup'|
 |TC_OR_DETAIL_LINK|the link to online review detail of challenge| see `default.js`, OR link for dev environment|
+|RETRY_COUNT| the number of times an event should be retried to process| 3|
+|RETRY_INTERVAL| the interval at which the event should be retried to process in milliseconds | 120000|
+|READY_FOR_REVIEW_ISSUE_LABEL| the label name for ready for review, should be one of the label configured in topcoder x ui|'tcx_ReadyForReview'|
 
 KAFKA_OPTIONS should be object as described in https://github.com/oleksiyk/kafka#ssl
 For using with SSL, the options should be as

config/default.js

@@ -84,6 +84,8 @@ module.exports = {
   PAID_ISSUE_LABEL: process.env.PAID_ISSUE_LABEL || 'tcx_Paid',
   FIX_ACCEPTED_ISSUE_LABEL: process.env.FIX_ACCEPTED_ISSUE_LABEL || 'tcx_FixAccepted',
   READY_FOR_REVIEW_ISSUE_LABEL: process.env.READY_FOR_REVIEW_ISSUE_LABEL || 'tcx_ReadyForReview',
+  ASSIGNED_ISSUE_LABEL: process.env.READY_FOR_REVIEW_ISSUE_LABEL || 'tcx_Assigned',
+  OPEN_FOR_PICKUP_ISSUE_LABEL: process.env.READY_FOR_REVIEW_ISSUE_LABEL || 'tcx_OpenForPickup',
   TC_OR_DETAIL_LINK: process.env.TC_OR_DETAIL_LINK || 'https://software.topcoder-dev.com/review/actions/ViewProjectDetails?pid=',
   RETRY_COUNT: process.env.RETRY_COUNT || 3,
   RETRY_INTERVAL: process.env.RETRY_INTERVAL || 120000, // 2 minutes

configuration.md

@@ -25,6 +25,8 @@ The following config parameters are supported, they are defined in `config/defau
 |GITLAB_API_BASE_URL| the URL for gitlab host| defaults to `https://gitlab.com`|
 |PAID_ISSUE_LABEL|the label name for paid, should be one of the label configured in topcoder x ui|'tcx_Paid'|
 |FIX_ACCEPTED_ISSUE_LABEL|the label name for fix accepted, should be one of the label configured in topcoder x ui|'tcx_FixAccepted'|
+|ASSIGNED_ISSUE_LABEL| the label name for assigned, should be one of the label configured in topcoder x ui| 'tcx_Assigned'|
+|OPEN_FOR_PICKUP_ISSUE_LABEL| the label name for open for pickup, should be one of the label configured in topcoder x ui| 'tcx_OpenForPickup'|
 |TC_OR_DETAIL_LINK|the link to online review detail of challenge| see `default.js`, OR link for dev environment|
 |RETRY_COUNT| the number of times an event should be retried to process| 3|
 |RETRY_INTERVAL| the interval at which the event should be retried to process in milliseconds | 120000|

models/Issue.js

@@ -25,8 +25,9 @@ const schema = new mongoose.Schema({
     default: Date.now
   },
   // From topcoder api
-  challengeId: {type: Number, required: true, unique: true},
-  projectId: {type: mongoose.Schema.Types.ObjectId, ref: 'Project'}
+  challengeId: {type: Number, required: false, unique: true},
+  projectId: {type: mongoose.Schema.Types.ObjectId, ref: 'Project'},
+  status: {type: String}
 });
 
 // Issue number, provider, repositoryId must be unique