​
Automated PR Documentation

Ellipsis automatically creates and maintains comprehensive summaries of your pull requests, saving you the time and effort of writing detailed descriptions. These summaries:

  • Provide clear explanations of what changed
  • Highlight key modifications across files
  • Update automatically as you add new commits
  • Follow your team’s documentation preferences

​
How It Works

​
Getting a Summary

To have Ellipsis create a summary for your pull request:

  1. Open a non-draft pull request
  2. Wait for Ellipsis to analyze your changes (you’ll see a 👀 reaction)
  3. Ellipsis will add a detailed summary as a comment

The summary will automatically update as you add new commits to your pull request, ensuring it always reflects the current state of your changes.

​
Automatic PR Titles

Ellipsis can even write your PR title for you! Simply:

  1. Create a pull request with ... (an ellipsis) as the title
  2. Ellipsis will generate a descriptive title based on your changes
  3. The title will be automatically updated

This is particularly useful for large or complex PRs where summarizing the changes in a title can be challenging.

​
Customization Options

Through the Ellipsis web interface, you can customize how summaries are generated:

​
Summary Rules

Add specific guidelines for how Ellipsis should create summaries, such as:

  • “Don’t mention changes in the /deprecated directory”
  • “Ignore whitespace-only changes”
  • “Briefly mention renamed files without listing every reference”
  • “Focus on functional changes rather than implementation details”

​
Enable/Disable Features

Control summary behavior through settings:

  • Turn automatic summaries on/off
  • Enable/disable automatic title generation
  • Set summary detail level (brief or comprehensive)
  • Choose when summaries should update (e.g., on every commit or only significant changes)

These settings can be adjusted on a per-repository basis through the Ellipsis dashboard.