accelerate

README

accelerate

Get velocity data about engineering teams

Description

In its current form, this is a very simple Github contributor scraper. Currently only evaluating the following attributes for each contributor since they joined the repo:

• Average addition lines of code per week
• Average deletion lines of code per week
• Average commits per week
• Total weeks since joined

There is a simple summary table that prints to stdout displaying each contributor and their weekly averages. Additionally there is a very basic chart printed to stdout that shows their additions by week so that we can see trends over time.

Getting Started

CLI Prerequisites

• Golang >= v1.19 installed

Download and run

$ go get github.com/jessicagreben/accelerate

Create a config file named config.yaml.

See an example config file that describes the config options.

Run:

$ accelerate