ContribSync — Automate Jira, GitHub contribution…

Pitch

Description

Comments

About this project

ContribSync simplifies the process of tracking contributions across Jira, GitHub, and more. It automatically fetches assigned issues and generates AI-driven self-evaluation drafts, helping engineers prepare for performance reviews in just minutes. With features such as Jira integration, GitHub summaries, and customizable outputs, it's a valuable tool for enhancing productivity and focus.

ContribSync (csync) is a command-line interface (CLI) tool designed to streamline the process of tracking and summarizing contributions from various platforms like Jira and GitHub. Aimed at engineers, this tool significantly reduces the time spent on preparing for performance reviews, allowing users to create comprehensive self-evaluation summaries in just a few minutes instead of days.

Key Features

Jira Integration

Automatically fetches assigned Jira tickets using JQL.
Summarizes ticket information with the help of advanced AI models (GPT-3.5 / GPT-4).
Produces clean Markdown output ready for performance reviews.

GitHub Functionality

Lists pull requests (PRs) created or merged during a selected timeframe.
Extracts relevant commit messages and PR descriptions.
Generates AI-driven activity summaries for easy evaluation.

Slack Plugin (Work in Progress)

Sends regular contribution reminders (daily or weekly).
Future plans include input capture via Slack for non-CLI users.

AI-Powered Summaries

Utilizes OpenAI technology to create concise summaries from raw ticket and PR data.
Offers configurable prompt structures for tailored outputs.
Provides an offline/manual mode to ensure data auditability.

Installation and Configuration

Before running ContribSync, ensure the necessary prerequisites are met, which include Go installation and Jira API access. Optional configurations for GitHub and Slack can enhance functionality.

Examples of Usage

Create a Jira Issue

./csync plugin exec jira create-issue "Optimize Sync Performance" "Improve background sync to reduce CPU usage."

Generate AI-Powered Summary for Self-Evaluation

./csync plugin exec jira summary your-email@example.com

These commands showcase how users can seamlessly generate summaries and issue reports, thus enabling a more effective performance review preparation process.

Extensibility and Future Enhancements

ContribSync is built to be extensible, inviting contributions such as additional platform plugins and enhancements to existing functionality. Users can expect regular updates and new features, ensuring the tool evolves to meet changing needs. Overall, ContribSync simplifies contribution tracking, helping users focus on impactful metrics rather than administrative overhead.