This document explains how lazypr templates work, how to create custom templates, and how to use the official template collection to customize Pull Request summaries generated by the lazypr AI-powered GitHub Action.

Overview

lazypr generates intelligent Pull Request summaries using predefined or custom templates. Templates act as AI instructions, defining what context is provided and how the summary should be structured.

lazypr supports:

• Built-in templates (presets)
• Repository-level custom templates

Template Types

1. Built-in Presets

lazypr ships with built-in template presets located at:

packages/config-presets/src/index.ts

These presets are useful for quick setup or standardized workflows.

2. Custom Templates

Custom templates allow full control over:

• Output structure
• Reviewer focus
• Tone (formal, concise, instructional, etc.)
• Audience (clients, OSS contributors, internal teams)

Custom templates live inside your repository and are automatically detected by lazypr.

Template Variables (Placeholders)

Templates may include the following dynamic placeholders. These are replaced automatically at runtime.

PR Metadata

Diff Context

Risk Context (Precomputed)

Custom Template Requirements

Every custom template must include the following placeholders:

• {{diff}}
• {{filesChanged}}

Templates that omit these required fields will not be processed correctly.

Custom Template Resolution Order

When custom_template is enabled, lazypr searches for templates in the following order (first match wins):

1. custom_template_path (if explicitly provided)
2. .github/lazypr-template.md
3. .lazypr/template.md
4. lazypr-template.md

Recommended Starter Template

This template is suitable for most projects and balances clarity, brevity, and reviewer context.

You are an expert reviewer. Produce a concise Markdown summary.

PR:

- Title: {{prTitle}}
- Author: {{prAuthor}}

Risk:

- {{riskLevel}} ({{riskScore}}/100)
- High-risk files: {{highRiskFiles}}

Files:
{{filesChanged}}

Diff:
{{diff}}

Output format:

### TL;DR

<1-2 sentences>

### Key Changes

- <bullets>

### Notes for Reviewers

- <bullets>

lazypr Summary Templates

This directory contains a curated collection of specialized and generic summary templates for the lazypr GitHub Action.

Each template is designed for a specific workflow, audience, or review style.

GitHub Repository

All templates are publicly available at:

👉 https://github.com/elvis-ndubuisi/lazypr/tree/main/templates

How to Use These Templates

Option 1: Default Template (Recommended)

1. Copy any template file.
2. Place it at:

.github/lazypr-template.md

lazypr will automatically detect and use it with no additional configuration.

Option 2: Specify Template in Workflow

To select a template per repository or workflow, configure the GitHub Action input:

- uses: elvis-ndubuisi/lazypr@v1
  with:
    api_key: ${{ secrets.GEMINI_API_KEY }}
    provider: gemini
    custom_template: true
    custom_template_path: templates/freelancer.md

Available Templates

Scenario-Specific Templates

Generic Use-Case Templates

Template Placeholders Reference

Required Placeholders

PR Metadata

Risk Assessment

Ticket Detection (v1.2.0+)

PR Size Metrics (v1.2.0+)

Custom Placeholders (v1.2.0+)

Any placeholders defined in custom_placeholders input are also available. See custom placeholders guide.

Template Design Rules

To ensure consistent and reliable output:

• Templates must be written as AI instructions
• Use Markdown formatting
• Avoid triple backticks inside instruction blocks unless intentionally required in output
• Clearly define the expected response in the Output Format section
• Optimize for clarity, not verbosity

Recommended Best Practices (Author Opinion)

• Use scenario-specific templates for teams and clients
• Keep templates opinionated but structured
• Treat templates as review standards, not just formatting tools
• Prefer multiple templates over one overly complex template
• Version templates alongside architectural changes