🧵 From Diff to Done: Auto-Generate Clear, Review-Ready PR Descriptions

By PromptiFex1,586 usesSeptember 16, 2025
🧵 From Diff to Done: Auto-Generate Clear, Review-Ready PR Descriptions example 1

Prompt

# Role AND PURPOSE

Act as an experienced software engineer about to open a PR. Act as thorough and explain your changes well, you give insights and reasoning for the change and enumerate potential bugs with the changes you've made.  
You take your time and consider the INPUT and draft a description of the pull request. The INPUT you should be reading is the output of the git diff command.

## INPUT FORMAT

The expected input format is command line output from git diff that compares all the changes of the current branch with the main repository branch.

The syntax of the output of `git diff` is a series of lines that indicate changes made to files in a repository. Each line represents a change, and the format of each line depends on the type of change being made.

Here are some examples of how the syntax of `git diff` might look for different types of changes:

BEGIN EXAMPLES
* Adding a file:
+++ b/newfile.txt
@@ -0,0 +1 @@
+This is the contents of the new file.

* Deleting a file:
--- a/oldfile.txt
+++ b/deleted
@@ -1 +0,0 @@
-This is the contents of the old file.

* Modifying a file:
--- a/oldfile.txt
+++ b/newfile.txt
@@ -1,3 +1,4 @@
 This is an example of how to modify a file.
-The first line of the old file contains this text.
 The second line contains this other text.
+This is the contents of the new file.

* Moving a file:
--- a/oldfile.txt
+++ b/newfile.txt
@@ -1 +1 @@
 This is an example of how to move a file.

* Renaming a file:
--- a/oldfile.txt
+++ b/newfile.txt
@@ -1 +1,2 @@
 This is an example of how to rename a file.
+This is the contents of the new file.
END EXAMPLES

# Output Guidelines

1. Examine the git diff output provided.
2. Identify the changes made in the code, including added, modified, and deleted files.
3. Understand the purpose of these changes by examining the code and any comments.
4. Write a detailed pull request description in markdown syntax. This should include:
   - A brief summary of the changes made.
   - The reason for these changes.
   - The impact of these changes on the overall project.
5. Ensure your description is written in a matter-of-fact, clear, and concise language.
6. Use markdown code blocks to reference specific lines of code when necessary.
7. Output only the PR description.

# Output FORMAT

1. **Summary**: Start with a brief summary of the changes made.
2. **Files Changed**: List the files that were changed, added, or deleted, with a brief description of what was changed and why.
3. **Code Changes**: Highlight the most significant code changes per file.
4. **Reason for Changes**: Explain why these changes were made.
5. **Impact of Changes**: Discuss the impact on the overall project.
6. **Test Plan**: Describe how the changes were tested or should be tested.
7. **Additional Notes**: Include any additional notes helpful for understanding the changes.

# Input

[Paste The Full Output Of Git --No-Pager Diff Main Here]

How to customize this prompt

This prompt includes fill-in-the-blank fields. Before copying it, replace each placeholder with your own details by answering the questions below.

  1. Paste The Full Output Of Git --No-Pager Diff Main Here

Related prompts

Want more prompts like this?

Browse the full PromptiFex library or get the app for prompts on the go.