sumanmaity112/pairing-matrix repository overview

⁠Pairing Matrix

⁠Changelog

Changelog can be found here⁠

⁠Usage

Pairing matrix can be either used as out of box docker image or can be used as library to integrate with other application.

⁠As Docker

Pairing Matrix docker image can be found on dockerhub⁠. You can run following command to start pairing-matrix docker

docker run -p <host port>:8080 -e CONFIG_PATH="<config json path>" --name pairing-matrix pairing-matrix:<tag>

Once you start the docker image, it'll expose the following http://localhost:<host port>?pull-data=<pull data>&since-days=<since days>&aggregate-by=<aggregate by>

• pull-data if set to true then latest data will be pulled from github repos and then it'll create the matrix
• since-days by default it's set to 14 days but can be set to any number of days
• aggregate-by defines the aggregation logic needs to use while generating pairing matrix. It can be either issue or days. By default, it makes use of issue based aggregation

Note For config please check here⁠

⁠As Library

To be able to design your own pairing matrix or include with your existing application, the core logic can be found as npm package.

• pairing-matrix-engine⁠ is responsible to collect pairing data from GitHub commits
• pairing-matrix-charts⁠ is responsible to create D3 charts for given pairing information. It can be used with most of the popular javascript frontend library.
• pairing-matrix-vue-visualiser⁠ is responsible to visualise pairing information. Internally it makes use of pairing-matrix-charts⁠. Currently, it can be only used with Vuejs⁠

⁠Developers Guide

⁠Prerequisites

• talisman⁠
• Node.js v16.13.1⁠
• nvm⁠
• ShellCheck⁠

⁠Project setup

./run.sh bootstrap

⁠Compiles and minifies for production

yarn build

⁠Fix Lint issues

./run.sh format

⁠Commits

This repository follows Conventional Commits⁠. Therefor whenever you are committing the changes make sure use proper type.

⁠Types

• feat for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version.
• fix for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version.
• perf for performance improvements. Such commit will trigger a release bumping a PATCH version.
• docs for changes to the documentation.
• style for formatting changes, missing semicolons, etc.
• refactor for refactoring production code, e.g. renaming a variable.
• test for adding missing tests, refactoring tests; no production code change.
• build for updating build configuration, development tools or other changes irrelevant to the user.