reputer

module
v0.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 7, 2023 License: Apache-2.0

README

reputer

Reporting tool to calculate contributor reputation based on plugable algorithm for each provider. Currently supports github and gitlab providers.

Note: reputation is a value between 0 (no/low reputation) to 1.0 (high reputation). The algorithms used in this repo currently consider only the provider information about each contributor so the reputation is more a identity confidence score until additional/external data sources are introduced.

build

make build

usage

Usage of bin/reputer (v0.0.1):
  -repo string
    	Repo URI (required, e.g. github.com/owner/repo)
  -commit string
    	Commit at which to end the report (optional, inclusive)
  -file string
    	Write output to file at this path (optional, stdout if not specified)
  -debug
    	Turns logging verbose (optional, false)

example:

bin/reputer \
    --repo github.com/mchmarny/reputer \
    --commit 3c239456ef63b45322b7ccdceb7f835c01fba862

results in:

{
  "repo": "github.com/mchmarny/reputer",
  "generated_on": "2023-06-06T22:34:35.273897Z",
  "total_commits": 180,
  "total_contributors": 10,
  "contributors": [
    {
      "username": "mchmarny",
      "created": "2010-01-04T00:19:57Z",
      "public_repos": 148,
      "private_repos": 26,
      "followers": 231,
      "following": 8,
      "commits": 18,
      "verified_commits": true,
      "strong_auth": true,
      "reputation": 0.95,
      "context": {
        "company": "@Google",
        "name": "Mark Chmarny"
        ...
      }
    },
    ...
  ]
}

Disclaimer

This is my personal project and it does not represent my employer. While I do my best to ensure that everything works, I take no responsibility for issues caused by this code.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL