Fixes for usability, clarity, and documentation

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

Author: jmgasper

configuration.md

@@ -26,6 +26,7 @@ The following config parameters are supported, they are defined in `src/config.j
 |LABELS| Labels we are going to add to the repository in the form of array of object with `name` and `color` property. Color should be hex code without hash||
 |ALLOWED_TOPCODER_ROLES| The allowed Topcoder role to use Topcoder X app| see configuration |
 |COPILOT_ROLE| The role to identify copilot|'copilot'|
+|HELP_LINK| The link for help| 'https://github.com/topcoder-platform/topcoder-x-ui/wiki'|
 
 ## GitHub OAuth App Setup
 

src/assets/WorkingWithTickets.md

@@ -0,0 +1,45 @@
+# How to work with git tickets
+
+The basic flow for handling a ticket is as follows:
+
+1. Assign the ticket to yourself, change the label to "tcx_Assigned", remove the "tcx_OpenForPickup" label.  Please only assign tickets to yourself when you are ready to work on it.  I don't want tickets assigned to someone and then not have them work on a ticket for 24 hours.  The goal here is a quick turnaround for the client.  If you can't work on a ticket immediately, leave it for someone else.
+
+1. Complete the ticket and create a merge request within 24 hours.  Please ensure your merge request can be merged automatically and that it's against the latest commit in Git when you create it.
+
+1. Change the label on the ticket to "tcx_ReadyForReview"
+
+After seeing a ticket marked as "tcx_ReadyForReview", the copilot will review that ticket, usually within 24 hours.
+
+Note that you are expected to keep your changes in-sync with Git - make sure to do a pull before you push changes to make sure there aren't any merge issues.
+
+### Accepted fix
+
+If a fix is accepted, a payment ticket will be created on the Topcoder platform within 5-10 minutes of the issue being closed.  You should see the payment in your PACTs within 24 hours.
+
+### Rejected fix
+
+If a fix is rejected, a comment, and possibly a screenshot, will be added to the ticket explaining why the fix was rejected.  The status will be changed to "tcx_Feedback".
+
+**If a fix is rejected, that ticket is your priority.  You should not assign yourself any more tickets until you complete the required additional fixes!**
+
+# Payment amounts
+
+Each ticket in GitLab has a dollar value.  That is the amount you will be paid when the ticket is completed, merged, and verified by the copilot.  Note that there is still a 30 day waiting period as the payment will be treated as a regular TopCoder challenge payment.
+
+# Important Rules:
+
+- You can assign any unassigned issue to yourself with an "Open for pick up" label (first come first serve)
+
+- You can only assign **ONE AT A TIME**. The nature of it being assigned will indicate it is not available to anyone else.
+
+- You will fix the ticket by committing changes to the master branch.
+
+- After marking a ticket "tcx_ReadyForReview" you are eligible to accept another. You do _NOT_ need to wait for the copilot to validate your fix.
+
+- You can do as many tickets as you want, as long as you follow the rules above.
+
+- If an assigned task is not done in 24 hours, you will need to explain why it is not completed as a comment on the ticket.
+
+- You can ask questions directly on the GitLab ticket.
+
+### ANYONE NOT FOLLOWING THE RULES ABOVE WILL BE WARNED AND POTENTIALLY LOSE THEIR GITLAB ACCESS!

src/config.js

@@ -38,4 +38,5 @@ module.exports = {
   LABELS: process.env.LABELS || [{ name: 'tcx_OpenForPickup', color: '428BCA' }, { name: 'tcx_Assigned', color: '004E00' }, { name: 'tcx_ReadyForReview', color: 'D1D100' }, { name: 'tcx_Paid', color: '7F8C8D' }, { name: 'tcx_Feedback', color: 'FF0000' }, { name: 'tcx_FixAccepted', color: '69D100' }],
   ALLOWED_TOPCODER_ROLES: process.env.ALLOWED_TOPCODER_ROLES || ['administrator', 'admin', 'connect manager', 'connect admin', 'copilot', 'connect copilot'],
   COPILOT_ROLE: process.env.COPILOT_ROLE || 'copilot',
+  HELP_LINK: process.env.HELP_LINK || 'https://github.com/topcoder-platform/topcoder-x-ui/wiki',
 };

src/controllers/AppConfigController.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2018 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This controller exposes application configuration related endpoints.
+ *
+ * @author veshu
+ * @version 1.0
+ */
+const helper = require('../common/helper');
+const AppConfigService = require('../services/AppConfigService');
+
+/**
+ * gets the application configuration required for frontend
+ * @returns {Object} the configuration details
+ */
+async function getAppConfig() {
+  return await AppConfigService.getAppConfig();
+}
+
+module.exports = {
+  getAppConfig,
+};
+
+helper.buildController(module.exports);

src/controllers/ProjectController.js

@@ -60,12 +60,23 @@ async function createHook(req) {
   return await ProjectService.createHook(req.body, req.currentUser.handle);
 }
 
+/**
+ * adds the wiki rules the project's repository
+ * @param {Object} req the request
+ * @param {Object} res the response
+ * @returns {Object} the result
+ */
+async function addWikiRules(req) {
+  return await ProjectService.addWikiRules(req.body, req.currentUser.handle);
+}
+
 module.exports = {
   create,
   update,
   getAll,
   createLabel,
   createHook,
+  addWikiRules,
 };
 
 helper.buildController(module.exports);

src/front/src/app/copilot-payments/copilot-payments-controller.js

@@ -6,6 +6,7 @@ angular.module('topcoderX')
       $scope.title = 'Copilot payment page';
       $scope.payments = [];
       $scope.isLoaded = false;
+      $scope.totalPendingAmounts = 0;
       $scope.topcoderUrl = '';
       $scope.status = '';
       $scope.goPayment = function (payment) {
@@ -32,6 +33,10 @@ angular.module('topcoderX')
         CopilotPaymentService.getAll('project').then(function (res) {
           if (status === 'active') {
             $scope.payments = res.data.activePayments;
+            $scope.totalPendingAmounts = 0;
+            for (var i = 0; i < $scope.payments.length; i++) {
+              $scope.totalPendingAmounts += $scope.payments[i].amount;
+            }
             $scope.isLoaded = true;
             $scope.status = 'active';
           }