Pairing Matrix engine

This package required codebase to build pairing matrix using github commits.

Installation

Use your favourite package manager:

• npm: npm install pairing-matrix-engine
• yarn: yarn add pairing-matrix-engine

Changelog

Changelog can be found here

Example Commit Structure

Example commit structures are following

• <commit message>
  
  Co-authored-by: <co-author name> <co-author email>
  

• <commit message>
  
  Addresses <issue/card number>
  
  Co-authored-by: <co-author name> <co-author email>
  

• <issue/card number> <commit message>
  
  Co-authored-by: <co-author name> <co-author email>
  

Note: Co-author syntax follows github co-author recommendation

Usage

Include into your JavaScript app as an ES Module:

import PairingMatrixGenerator from "pairing-matrix-engine";

const pairingMatrixGenerator = new PairingMatrixGenerator(
  username,
  repos,
  basePath,
  sshIdentityFilePath
);

await pairingMatrixGenerator.generatePairingMatrix(
  14,
  true,
  PairingMatrixGenerator.AGGREGATE_BY_DAYS
);

API

Create new of PairingMatrixGenerator

new PairingMatrixGenerator(username, repos, basePath, [sshIdentityFilePath]);

// new PairingMatrixGenerator("johndoe", [ "repo1", "repo2" ], "~/temp", "~/.ssh/id_rsa");

Create new instance of pairing matrix for given username, repos, basePath and sshIdentityFilePath. sshIdentityFilePath is optional parameter, it's only required when different identity file is required to pull data from github.

Fetch data from github

await pairingMatrixGenerator.fetchRepos();

Pull data from github for configured repos. fetchRepos method returns a Promise.

Generate Pairing Matrix

await pairingMatrixGenerator.generatePairingMatrix(
  sinceDays,
  [pullData],
  [aggreateBy],
  [cardNumberPrefix]
);

// await pairingMatrixGenerator.generatePairingMatrix(14, true, PairingMatrixGenerator.AGGREGATE_BY_DAYS);
// await pairingMatrixGenerator.generatePairingMatrix(14, true, PairingMatrixGenerator.AGGREGATE_BY_ISSUE, "Addresses");

Generate pairing matrix for given number of days. generatePairingMatrix returns a Promise.

Parameters

• sinceDays is a required parameter, indicates the number of days for which matrix needs to be generated
• pullData is an optional Boolean parameter, depends on this parameter generatePairingMatrix will pull data from GitHub and create the pairing matrix. By default, it is set to false.
• aggreateBy is an optional parameter, which indicates the aggregation needs to used while generating pairing matrix. Currently, it supports following options
  • PairingMatrixGenerator.AGGREGATE_BY_DAYS aggregate by days (default)
  • PairingMatrixGenerator.AGGREGATE_BY_ISSUE aggregate by issue
• cardNumberPrefix is an optional parameter which indicates the reference prefix for card/issue number. By default, it set to Addresses. This parameter is only used when aggreateBy is set to PairingMatrixGenerator.AGGREGATE_BY_ISSUE.

Example data

{
  "matrix": [
    {
      "author": "john.reese",
      "coAuthor": "zoe.morgan",
      "times": 2
    },
    {
      "author": "john.reese",
      "coAuthor": "tonystark",
      "times": 1
    },
    {
      "author": "steve",
      "coAuthor": "diana",
      "times": 1
    },
    {
      "author": "natasha",
      "coAuthor": "tonystark",
      "times": 2
    },
    {
      "author": "bruce_banner",
      "coAuthor": "rohdy",
      "times": 2
    },
    {
      "author": "steve",
      "coAuthor": "natasha",
      "times": 2
    },
    {
      "author": "barry.allen",
      "coAuthor": "oliver",
      "times": 2
    },
    {
      "author": "barry.allen",
      "coAuthor": "steve",
      "times": 1
    }
  ],
  "authors": [
    "john.reese",
    "zoe.morgan",
    "tonystark",
    "steve",
    "diana",
    "natasha",
    "bruce_banner",
    "rohdy",
    "barry.allen",
    "oliver"
  ]
}

Generate Pair Recommendation

await pairingMatrixGenerator.generatePairRecommendation(
  [sinceDays],
  [pullData]
);

// await pairingMatrixGenerator.generatePairRecommendation();
// await pairingMatrixGenerator.generatePairRecommendation(60, true);

Generate pair suggestion considering given number of days. generatePairRecommendation returns a Promise.

Parameters

• sinceDays is an optional parameter, indicates the number of days to consider while generating the recommendation list. By default, it set to 14.
• pullData is an optional Boolean parameter, depends on this parameter generatePairingMatrix will pull data from GitHub and create the pairing matrix. By default, it is set to false.

Example data

{
  "john": ["tony", "kweller", "jweller"],
  "kweller": ["jweller", "tony", "john"],
  "jweller": ["kweller", "tony", "john"],
  "tony": ["john", "kweller", "jweller"]
}