From 38f37bd7c0b23d99b9c55861f307c587cd732608 Mon Sep 17 00:00:00 2001 From: Jyoti Mishra Date: Tue, 16 Dec 2025 11:07:05 +0530 Subject: [PATCH 1/2] Add High level workflow section to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index cd001ba..1964f4e 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,18 @@ The Disgitbot project aims to create a comprehensive Discord bot that integrates GitHub activity with Discord communities, providing real-time notifications, contribution analytics, and automated workflow management. The project focuses on enhancing community engagement and streamlining development workflows through intelligent automation. +## How DisGitBot Works (High-Level) + +DisGitBot bridges GitHub repositories and Discord communities by automatically capturing +repository activity and presenting useful insights inside Discord. + +At a high level: +1. GitHub webhooks listen for events such as pull requests, commits, and issues +2. Incoming events are validated and processed by backend services +3. Automation and AI-assisted logic handle labeling, reviews, and classification +4. Contribution data is stored and indexed for analytics +5. Results are delivered to Discord via bot commands, roles, and notifications + --- ## Timeline & Tasks From 402c6a636296d595d2c6fd94b6b701f25e2223ca Mon Sep 17 00:00:00 2001 From: Jyoti Mishra Date: Tue, 16 Dec 2025 21:23:15 +0530 Subject: [PATCH 2/2] Add diagram explanations to improve README clarity --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 1964f4e..f30adba 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,10 @@ At a high level:

Diagram 1: Discord Bot for Real-Time GitHub Contribution Stats - Data Pipeline Architecture

+
This diagram shows the end-to-end data pipeline used by DisGitBot to collect GitHub +contribution data, process it through analytics workflows, store results, and expose +real-time statistics to users via Discord commands.
+ ```mermaid graph TD @@ -166,6 +170,10 @@ graph TD

Diagram 2: Discord Role Auto-Update Bot - Role Update Workflow

+
This diagram illustrates the automated workflow used by DisGitBot to periodically +evaluate GitHub contributions, determine contributor role levels, and synchronize +Discord server roles based on updated contribution statistics.
+ ```mermaid graph TD @@ -193,6 +201,10 @@ graph TD

Diagram 3: AI-Assisted Pull Request Review Integration - PR Review Automation

+
This diagram describes the automated pull request review workflow in DisGitBot, +where PR events trigger AI-assisted analysis, metrics computation, label prediction, +reviewer assignment, and notification of review outcomes.
+ ```mermaid graph TD @@ -227,6 +239,10 @@ graph TD

Diagram 4: Automatic Labelling for PRs Using PR Labeller - AI Labeling System

+
This diagram outlines the AI-driven pull request labeling workflow, where PR events +trigger automated analysis using repository-specific labels, confidence-based +classification, and application of labels to ensure consistent and efficient PR tagging.
+ ```mermaid graph TD @@ -260,6 +276,10 @@ graph TD

Diagram 5: Research Metric Tracking and Channel Creation - Metrics & Channels

+
This diagram shows how DisGitBot periodically aggregates repository metrics and +synchronizes them with Discord by creating and updating channels that display +live repository statistics in real time. +
```mermaid graph TD @@ -287,6 +307,10 @@ graph TD

Diagram 6: Contributor Analytics and Hall of Fame Visualization - Analytics & Visualization

+
This diagram illustrates how DisGitBot processes contribution data to generate +analytics, hall-of-fame rankings, and visual insights, which are then exposed +to users through interactive Discord charts and commands.
+ ```mermaid graph TD