Prompt library

GitHub prompts

Prompts for GitHub workflows: pull request descriptions, issue triage, and release notes from merged changes.

  • pull requests
  • code review
  • documentation
100/100 · 154 tokens

Pull request description

Writes a pull request description from a diff: what changed, why, and how to test it.

Use it when: You finished a change and want a description a reviewer can act on without reading every line first.

prompt
You are a senior software engineer writing a pull request description.

## Task
Write a pull request description for the diff below.

## Requirements
- Describe only changes present in the diff.
- Explain why the change was made using the context provided; write "reason not provided" when the context does not say.
- List the steps a reviewer follows to test the change.
- Name any migration, configuration change, or breaking change.
- Keep the whole description under 250 words.

## Output format
Return markdown with four sections: Summary (2 sentences), Changes (bulleted list), How to test (numbered list), and Notes for reviewers (bulleted list).

## Input
<diff>
{{diff}}
</diff>

<context>
{{context}}
</context>
Optimize in workspace

Variables

{{diff}}
The output of git diff for the branch.
{{context}}
The issue or reason for the change.

Example input

diff: adds a retry wrapper around the payment client and a config value PAYMENT_MAX_RETRIES.
context: payments fail when the provider returns 503.

Example output

## Summary
Retries payment requests that fail with 503. The retry count is configurable.

## Changes
- Add `withRetry` in payment/client.ts
- Add `PAYMENT_MAX_RETRIES` (default 3)

## How to test
1. Set the provider mock to return 503 twice...

Illustrative: written to show the expected shape, not generated by a model.

  • release notes
  • changelog
  • documentation
100/100 · 162 tokens

Release notes from merged pull requests

Groups merged pull requests into release notes written for the people who use the software.

Use it when: Cutting a release and turning a list of pull request titles into notes users can read.

prompt
You are a maintainer writing release notes for users of the project.

## Task
Write release notes from the list of merged pull requests below.

## Requirements
- Group entries under Added, Changed, Fixed, and Removed.
- Rewrite each entry to say what changed for the user, in one sentence.
- Keep the pull request number at the end of each entry.
- Put breaking changes first under a "Breaking changes" heading, with the action users must take.
- Leave out entries that only change tests, tooling, or internal refactoring.

## Output format
Return markdown with one heading per group that has entries and a bulleted list under each. Do not include empty groups.

## Input
<version>
{{version}}
</version>

<pull_requests>
{{pull_requests}}
</pull_requests>
Optimize in workspace

Variables

{{version}}
The version number being released.
{{pull_requests}}
The merged pull requests, one per line, with number and title.

Example input

version: 2.4.0
pull_requests: #412 feat: add CSV export; #415 fix: crash on empty project; #418 chore: bump eslint.

Example output

## Added
- Export any report as a CSV file. (#412)

## Fixed
- Opening a project with no items no longer crashes the app. (#415)

Illustrative: written to show the expected shape, not generated by a model.

Make it yours

Edit the requirements to match your standards, then check the result. Theprompt analyzer re-scores it as you type, theoptimizer removes filler without dropping a requirement, and thesecurity scanner flags secrets and personal data before you send it to a model.

More categories