Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.02 KB

README.md

File metadata and controls

81 lines (59 loc) · 3.02 KB

Version Control Activity Analyzer

Open Source Love svg1 GitHub license GitHub go.mod Go version of a Go module GitHub Open Issues PRs Welcome

Logo

A command-line tool for analyzing version control activity in Git repositories. This tool provides insights into commit history, identifies bottlenecks, and detects anti-patterns in a project's version control workflow.

Features

  • Commit History Analysis: Get detailed statistics about the commit history, including the total number of commits and contributions by each developer.
  • Bottleneck Identification: Identify potential bottlenecks in the workflow, such as long-lived branches and infrequent commits.
  • Anti-Pattern Detection: Detect common anti-patterns like large commits, force pushes, and other practices that may hinder collaboration and code quality.

Prerequisites

  • Git
  • Go (version 1.18 or higher)

Installation

Clone the repository

git clone https://github.com/adigulalkari/VC-Analyzer.git
cd VC-Analyzer

Run main

chmod +x build.sh
./build.sh

Usage

vc-analyze --help

Documentation

vc-analyze --help

image

vc-analyze calc-stats path/to/local/repo

Provides the following stats:

  • All commit history msgs
  • Stats on the contributions per author
  • Active/Inactive branches

vc-analyze check-anti-patterns path/to/local/repo

Provides the following functionalities

  • Checking large commits
  • Checking for force pushes
  • Flag large binary files in commits that bloat the repository

Contributing

Contributions are welcome! Please follow these steps to contribute to the project:

  • Fork the repository.
  • Create a new branch: git checkout -b feature-branch
  • Make your changes and commit them: git commit -m "Add new feature"
  • Push to the branch: git push origin feature-branch
  • Open a pull request.

Refer to CONTRIBUTING.md for more guidelines!

LICENSE

See the LICENSE file for license rights and limitations (MIT).