Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implements AI driven pull request description generator #6397

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

walmat
Copy link
Contributor

@walmat walmat commented Jan 13, 2025

What changed (plus any additional context for devs)

1. New AI Documentation System

File Structure

  • Added ai/pull-request-description.md template file
  • Created prs/ directory for generated PR descriptions
  • Added .gitkeep to maintain prs/ directory in git

Template Implementation

  • Added structured markdown template for PR descriptions
  • Defined consistent format for documenting changes:
    • Major changes sections
    • Subsections with bullet points
    • TLDR summary section

2. Git Configuration Updates

Gitignore Changes

  • Added prs/*.md to .gitignore
  • Ensures generated PR descriptions don't get committed
  • Maintains clean git history

Documentation

  • Added example TLDR format
  • Included instructions for template usage
  • Provided clear structure for organizing PR changes

3. Process Automation

PR Description Generation

  • Added system for automated PR description generation
  • Implemented parsing of PR numbers from GitHub URLs
  • Created standardized naming convention for PR description files

This PR introduces an AI-powered system for generating structured pull request descriptions, improving documentation consistency and making it easier to understand changes across the codebase.

How to use

@https://patch-diff.githubusercontent.com/raw/rainbow-me/rainbow/pull/<PULL_REQUEST_NUMBER>.diff @pull-request-description.md

Screen recordings / screenshots

n/a

What to test

n/a

@brunobar79
Copy link
Member

Launch in simulator or device for d7a20e0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants