https://github.com/mchmarny/reputer

Contributor reputation reporting tool
https://github.com/mchmarny/reputer

contribution git identity reputation

Last synced: 5 days ago
JSON representation

Contributor reputation reporting tool

• Host: GitHub
• URL: https://github.com/mchmarny/reputer
• Owner: mchmarny
• License: apache-2.0
• Created: 2023-06-04T17:33:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-05T21:16:13.000Z (about 1 year ago)
• Last Synced: 2024-06-21T08:12:05.556Z (5 months ago)
• Topics: contribution, git, identity, reputation
• Language: Go
• Homepage:
• Size: 3.63 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# reputer

Reporting tool to calculate contributor reputation based on configurable algorithm for each provider. Currently supported providers: `github` and `gitlab`.  

> 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. 

## install 

```shell

brew tap mchmarny/reputer

brew install mchmarny/reputer/reputer

```

## usage

```shell

reputer [flags]

```

Supported flags:

* `--commit` - Commit at which to end the report (optional, inclusive)

* `--file` - Write output to file at this path (optional, stdout if not specified)

* `--repo` - Repo URI (required, e.g. github.com/owner/repo)

* `--stats` - Includes author commit stats (optional, false)

* `--version` - Prints version only (optional, false)

* `--debug` - Turns logging verbose (optional, false)

```

example: 

```shell

reputer \

    --repo github.com/mchmarny/reputer \

    --commit 3c239456ef63b45322b7ccdceb7f835c01fba862

```

results in: 

```json

{

  "repo": "github.com/mchmarny/reputer",

  "generated_on": "2023-06-10T14:49:19.417079Z",

  "total_commits": 338,

  "total_contributors": 4,

  "contributors": [

    {

      "username": "mchmarny",

      "reputation": 0.95,

    },

    ...

  ]

}

```

Same command with `--stats`

```json

{

  "repo": "github.com/mchmarny/reputer",

  "generated_on": "2023-06-10T14:49:19.417079Z",

  "total_commits": 338,

  "total_contributors": 4,

  "contributors": [

    {

      "username": "mchmarny",

      "reputation": 0.95,

      "context": {

        "company": "@Company",

        "created": "2010-01-04T00:19:57Z",

        "name": "Mark Chmarny"

      },

      "stats": {

        "verified_commits": true,

        "strong_auth": true,

        "age_days": 4906,

        "commits": 282,

        "unverified_commits": 0,

        "public_repos": 149,

        "private_repos": 26,

        "followers": 231,

        "following": 8

      }

    },

    ...

  ]

}

```

## 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.