accelerate

command module
v0.0.0-...-64e3052 Latest Latest
Warning

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

Go to latest
Published: Feb 20, 2023 License: MIT Imports: 6 Imported by: 0

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.

example of contributors weekly data summary table

example of contributors additions-by-week graph

Getting Started

CLI Prerequisites
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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

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