https://github.com/rishabh3562/commitiq
Dev insights from GitHub, straight into your Slack.
https://github.com/rishabh3562/commitiq
ai analysis analytics langchain langraph llm orchestration python python3 slack slack-bot tool
Last synced: 11 months ago
JSON representation
Dev insights from GitHub, straight into your Slack.
- Host: GitHub
- URL: https://github.com/rishabh3562/commitiq
- Owner: rishabh3562
- License: mit
- Created: 2025-07-05T18:05:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-10T13:14:24.000Z (11 months ago)
- Last Synced: 2025-07-10T18:55:18.611Z (11 months ago)
- Topics: ai, analysis, analytics, langchain, langraph, llm, orchestration, python, python3, slack, slack-bot, tool
- Language: Python
- Homepage: https://dubeyrishabh108.vercel.app/projects/commitiq
- Size: 67.4 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# **CommitIQ – Engineering Productivity Insights**
> 📊 Transform GitHub activity into DORA-aligned insights directly in Slack
> ⚙️ Powered by LangGraph agents and Python 3.10+
---
## 📑 Table of Contents
* [Overview](#overview)
* [Features](#features)
* [Architecture](#architecture)
* [Setup](#setup)
* [Usage](#usage)
* [Agents](#agents)
* [Data Flow](#data-flow)
* [Visualization](#visualization)
* [Prompt Logging](#prompt-logging)
* [Tech Stack](#tech-stack)
* [Contributing](#contributing)
* [License](#license)
---
## Overview
**CommitIQ** is an agent-based engineering intelligence bot that integrates GitHub with Slack, providing real-time DORA metrics and performance summaries.
---
## Features
* 📥 GitHub ingest (live or static)
* 🧠 LangGraph-based agent pipeline
* 🧾 Slack slash commands with narrative + charts
* 🔍 Auditable prompt logging
* ⚡ Docker-first, one-command deploy
---
## Architecture
```
start_node
↓
harvester_orchestrator
↓↘︎↘︎↘︎ (parallel)
harvester_i → diff_analyst_i
↘︎↘︎↘︎
batch_collector
↓
aggregator
↓
narrator
↓
slack_reporter
```
Each `harvester_i` and corresponding `diff_analyst_i` node runs in **parallel**, managed by `harvester_orchestrator`. All analysis results are merged via `batch_collector` before aggregation and insight narration.
---
## Setup
### 1. Python Setup
```bash
pip install -r requirements.txt
python main.py
```
### 2. Docker Setup
```bash
docker-compose up --build # First time
docker-compose up # Subsequent runs
```
### 3. Create `.env` from `.env.sample`
Fill in your keys:
```env
# GitHub
GITHUB_TOKEN=ghp_xxx # GitHub personal access token with repo read access
#only in v1 (not used though but good to have this)
USE_FAKE_DATA=False
# Slack
SLACK_BOT_TOKEN=xoxb-xxx # Slack bot token
SLACK_APP_TOKEN=xapp-xxx # Slack app-level token (for Socket Mode)
SLACK_SIGNING_SECRET=xxxx # Slack signing secret
# OpenAI (or other LLM)
OPENAI_API_KEY=sk-xxx # Required if you're using OpenAI
# Optional - if using LangGraph/chain-specific services
LANGCHAIN_API_KEY=xxx # If using LangSmith for logging/tracing
```
---
## Usage
### ✅ `/dev-report owner repo [options]`
Generates AI-powered GitHub report with:
* DORA metrics
* PNG chart
* Narrative summary
**Examples:**
```bash
/dev-report hashicorp terraform
/dev-report hashicorp terraform --monthly
/dev-report hashicorp terraform --from 2024-06-01 --to 2024-06-30
```
**Optional Flags:**
| Flag | Description |
| ------------- | ------------------------- |
| `--weekly` | Past 7 days (default) |
| `--monthly` | Past 30 days |
| `--from DATE` | Start date |
| `--to DATE` | End date |
| `--yesterday` | Report for yesterday only |
| `--today` | Report for today only |
| `--no-graph` | Text summary only |
---
## Agents
* **start\_node** – Initializes the state
* **harvester\_orchestrator** – Launches parallel harvesters
* **harvester\_i** – Fetches GitHub commits in segments
* **diff\_analyst\_i** – Analyzes diffs per segment
* **batch\_collector** – Merges results from all analysts
* **aggregator** – Computes DORA and code metrics
* **narrator** – Generates summaries and insights
* **slack\_reporter** – Sends results to Slack
---
## Data Flow
1. GitHub data collected in shards
2. Each shard is analyzed for diffs and churn
3. All results collected, aggregated, and summarized
4. Report posted to Slack with chart and narrative
---
## Visualization
* Charts rendered using `matplotlib`
* Sent as PNG in Slack threads
---
## Prompt Logging
* Inputs, prompts, and responses are logged
* Optional file-based logging support
---
## Tech Stack
* **LangChain** `0.3.26`
* **LangGraph OSS** `0.5.0`
* \*\*Slack Bolt (Python)\`
* **matplotlib**, **Docker**, **Python 3.10+**
---
## Contributing
PRs welcome — this repository follows formal open-source standards:
* [Code of Conduct](./CODE_OF_CONDUCT.md)
* [Contributing Guide](./CONTRIBUTING.md)
* [Issue Template](./ISSUE_TEMPLATE.md)
* [Security Policy](./SECURITY.md)
Please review them before contributing or reporting issues.
---
## License
[MIT License](LICENSE)