Skip to content
Evaluate velocity data about engineering teams.
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.md
example-config.yaml
go.mod
go.sum
main.go
sample-graph.png
sample-summary-table.png

README.md

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

Clone down repo:

$ git clone github.com/jessicagreben/accelerate

Create a config file in the root of the project named config.yaml.

See an example config file that describes the config options.

Install and run:

$ go install
$ accelerate

Running tests

WIP

Deployment

WIP

Built With

  • Viper - Go configuration tooling

Contributing

WIP

Authors

See the list of contributors who have participated in this project.

License

This project is licensed under the MIT License.

You can’t perform that action at this time.