go-gopher

go-gopher is a git workflow analysis tool to check cohesion to popular git workflows

Cloning

This repository acts as a monorepo for development and data analysis. Results data is tracked as a submodule which powers the jupiter-notebooks, however it is non-essential for usage of the tool. If you requrie this data clone with the recurse-submodules flag.

Running

1. Ensure that the project environment file is filled out
2. Run make in the root of the project directory to create the project binaries that will output to bin/
3. Run the binary ./bin/go-gopher help to display help.

A good starting point is to navigate to a git project and run the go-gopher tool: go-gopher analyze local ./ --csv

Environment

Environment variables are defined in the .env which should be created from the .env.example template.

Configuration

Detectors can be toggled and weighted within config/config.yml

GitHub Action

This project is available as a GitHub action. An example usage can be found within this project. The action has been published via the go-gopher-action repository.

Documentation

Documentation for best practices and development decisions can be found in docs