Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/altiran/git-griffin

Comprehensive Git commit analysis tool implemented in C++
https://github.com/altiran/git-griffin

git git-tools github

Last synced: 18 days ago
JSON representation

Comprehensive Git commit analysis tool implemented in C++

Awesome Lists containing this project

README

        

# GitGriffin

GitGriffin is a powerful commit analysis tool implemented in C++. It provides comprehensive insights into Git repository
histories, author contributions, and commit patterns.

[ ![Build Status](https://github.com/Altiran/git-griffin/actions/workflows/main.yml/badge.svg "Build Status")](https://github.com/Altiran/git-griffin)
[ ![Discord](https://canary.discordapp.com/api/guilds/729950513352933386/widget.png) ](https://discord.gg/jsSGFeR)
[ ![Latest Release](https://img.shields.io/badge/Latest%20Release-v1.0.0-orange)](https://github.com/Altiran/git-griffin/releases/tag/v1.0.0)
[ ![GitHub Forks](https://img.shields.io/github/forks/Altiran/git-griffin.svg)](https://github.com/Altiran/git-griffin/fork)
[ ![GitHub Stars](https://img.shields.io/github/stars/Altiran/git-griffin.svg)](https://github.com/Altiran/git-griffin/stargazers)
[ ![GitHub Watches](https://img.shields.io/github/watchers/Altiran/git-griffin.svg)](https://github.com/Altiran/git-griffin/watchers)
[ ![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/Altiran/git-griffin/graphs/commit-activity)
[ ![Maintainer](https://img.shields.io/badge/Maintainer-Altiran_Studios-blue)](https://github.com/Altiran)
[ ![WakaTime](https://wakatime.com/badge/github/Altiran/git-griffin.svg)](https://wakatime.com/badge/github/Altiran/git-griffin)

**Like the project? Make sure to leave a ⭐ on the repository!**

## Overview

GitGriffin allows you to analyze commits in Git repositories, offering detailed reports on commit frequency, author
contributions, and other relevant metrics.

## Features

- **Commit Analysis**: Gain insights into commit frequency, distribution, and patterns over time.
- **Author Contributions**: Understand the impact of each author on the repository through commit analysis.
- **Integration**: Seamless integration into existing Git workflows for enhanced project management.

## Download

Download the latest release for your operating system from
the [GitHub Releases page](https://github.com/Altiran/catsay/releases/latest).

## Compilation

To compile GitGriffin yourself, follow these steps:

1. **Clone Repository**: Clone the Git repository to your local machine.
2. **Build Project**: Use the provided Makefile to build the GitGriffin executable.
3. **Run GitGriffin**: Execute the GitGriffin binary with the path to your Git repository.

## Example Output

After running GitGriffin, you'll see analysis results like the following:

```
Commit Analysis Report:

Commits per Author:
John Doe: 20
Jane Smith: 15

Commits per Day:
2023-07-01: 5
2023-07-02: 10
```

## License

"GitGriffin" is published under the MIT License.
See [LICENSE.md](https://github.com/Altiran/git-griffin/blob/main/LICENSE.md) for details.