Overview

PR Story is a GitHub bot that transforms pull requests into visual narratives.

🌿 Inspiration - We Don’t Make Mistakes, Just Happy Little PRs

"Happy little accidents" in pull requests made us realise: code reviews lack visual storytelling. Inspired by Bob Ross’s joy of creation, we wanted to turn dry PR diffs into engaging storyboards. Frustration with miscommunication in async teams → Could we make PRs feel like a collaborative art session?

🎨 What it Does - Painting Your Code’s Happy Place

When a PR is created, our bot analyses the content of the commit messages and generates a series of images that tell the story of the code changes, posting them directly as comments on the PR. Highlights key changes, generates a shareable comic-style summary for non-technical stakeholders.

How we built it

  • FastAPI Server: Running a text-to-image model locally and exposed via Localtunnel.
  • GitHub Integration: Custom app that sets up webhooks to detect new PRs.
  • AI Generation Pipeline: Utilising OpenAI and Diffusers to analyse PRs and generate text-to-image prompts.
  • Bot Implementation: Python-based GitHub bot that posts the generated storyboards as PR comments.

🌧 Challenges - Cloudy with a Chance of Merge Conflicts

  • Image Quality Issues: Initially, our model produced hallucinations and generic images that didn't properly follow our prompts.
  • GitHub API Complexity: Navigating the intricate details of GitHub's API presented a steeper learning curve than anticipated.

Accomplishments that we're proud of

  • Prompt Engineering Mastery: Learned how subtle tweaks to input prompts dramatically change output quality.
  • Black-box Model Interaction: Developed skills for effectively working with AI models through systematic trial and error.
  • Integration Success: Successfully connected multiple systems into a cohesive workflow.

What we learned

  • GitHub API integration patterns
  • Localtunnel for exposing local services
  • FastAPI for efficient API development
  • Stable Diffusion image generation techniques
  • Effective prompt engineering strategies

What's next for PR Story

  • Audio Integration: Generate songs based on commit messages.
  • Narrated Stories: Add Bob Ross-style narration to PR visualisations.
  • Enhanced Image Relevance: Improve specificity of generated images to better match code context.

Built With

Share this project:

Updates