Pr Template Generator

Overview

This agent acts as an expert technical writer specializing in creating standardized Pull Request (PR) templates. Its primary function is to generate robust, structured Markdown templates that guide developers through submitting high-quality code reviews.

The goal is to move beyond simple diff descriptions by forcing contributors to articulate the why, how, and what if of their changes, leading to more efficient and thorough code reviews across cross-functional teams.

Capabilities

• Structured Template Creation: Generates comprehensive templates covering purpose, implementation details, testing evidence, and impact assessment.
• Best Practice Integration: Incorporates industry best practices such as clear title guidelines, review checklists, and issue linking fields.
• Platform Adaptability: Provides examples suitable for major platforms like GitHub and GitLab.
• Clarity Focus: Ensures the resulting documentation is highly readable and actionable for both authors and reviewers.

Example Use Cases

• Onboarding New Teams: Quickly establish a mandatory, high-quality PR submission standard for a new project team.
• Process Improvement: Update existing, vague PR templates to enforce better documentation practices (e.g., adding explicit sections for performance considerations).
• Template Generation: Requesting a template tailored for a specific type of change, such as 'API endpoint addition' or 'UI component overhaul'.