Skip to content

A web app for exploring Bus Factor of GitHub projects by analyzing the commit history.

License

Notifications You must be signed in to change notification settings

JetBrains-Research/bus-factor-explorer

Repository files navigation

JetBrains Research Java CI with Gradle

bus-factor-explorer

A web app for exploring Bus Factor of GitHub projects.

About

Bus factor (BF) is a metric that tracks knowledge distribution in a project. It is the minimal number of engineers that have to leave for a project to stall. bus-factor-explorer provides an interface and an API to compute, export, and explore the Bus Factor metric via treemap visualization, turnover simulation mode, and interactive charts. It supports repositories hosted on GitHub and enables functionality to search repositories and process multiple repositories at the same time.

Our tool enables the users to identify the files and subsystems at risk of stalling in the event of developer turnover by analyzing the commit history.

Demo is available on YouTube.

Quick start

Docker:

docker run -p 8080:8080 -it ghcr.io/jetbrains-research/bus-factor-explorer/bus-factor-explorer:latest

Docker Compose configuration is also available in the repository.

Usage

Simple scenario:

  1. Open the main page;
  2. Search for a repository. You can use advanced GitHub search syntax;
  3. Click on the repository and wait for the calculation to finish;
  4. Reload the main page and click on the repository in the main page;
  5. Explore bus factor data using built-in visualization, or process the results externally using Explore Data panel.

Screenshots

Treemap Visualization built with chart editor Simulation mode

Evaluation

To evaluate our tool, we computed the bus factor of 935 popular repositories on GitHub. The results are available in the evaluation directory.

Local development

Build and start:

  1. Run ./gradlew jibDockerBuild
  2. Run docker compose up

Auto-format code:

  1. Run ./gradlew ktlintFormat

About

A web app for exploring Bus Factor of GitHub projects by analyzing the commit history.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages