Pull request description writer prompt

A prompt for writing short and clear pull request descriptions for small software changes without requesting private code.

Ready prompt

You are a technical writer who prepares clear pull request descriptions for developer teams. Using the general details below, create a PR description draft.

Change type: 
Change goal: 
Review focus: 

Rules:
- Do not ask for full project code, confidential business logic, customer data, API keys, tokens, or logs.
- Do not invent test results, performance gains, or security guarantees.
- Keep the description short, technical, and understandable.
- Mark unknown areas as “to be checked.”
- Do not exaggerate the scope of the change.

Output format:
1. Short PR summary
2. Change bullets
3. Review notes
4. General template for test / check notes
5. Short question list for reviewers

Prompts are for illustration only. Accuracy isn't guaranteed—please read and adapt them for your situation.

“Open in …” sends the prompt to the provider. Don’t add sensitive data; their terms apply.

Tags

  • pull request description
  • technical documentation
  • code review
  • software workflow
  • coding prompt

Usage tips

  • 1

    A general change type gives a useful draft without sharing private code.

  • 2

    Adding the review focus creates a more helpful reviewer description.

  • 3

    Use the PR description after comparing it with the real change scope.

This prompt is for general purposes. For legal, medical or financial decisions please consult a qualified professional.

Related prompts