Skip to content

Commit 6104efb

Browse files
replace old example prompt (#247)
* replace old example prompt * fix copypasta
1 parent 9527c29 commit 6104efb

File tree

1 file changed

+66
-20
lines changed

1 file changed

+66
-20
lines changed

Diff for: docs/guides/custom-reports.md

+66-20
Original file line numberDiff line numberDiff line change
@@ -115,26 +115,72 @@ Contained within the `<pr_details>` tag.
115115
Here's an example prompt that uses these data points:
116116

117117
```text
118-
Generate a summary with the following format for each PR:
119-
120-
## [PR Title](URL)
121-
**Status**: {Use these symbols based on state}
122-
- 🔀 if Merged is true
123-
- 📝 if Draft is true
124-
- 💬 if State is "open"
125-
- 🔒 if State is "closed" and not merged
126-
Add ⚠️ if Is stale is true
127-
128-
**Author**: {Author name}
129-
**Created**: {Created at}
130-
**Labels**: {Labels joined by commas}
131-
**Reviewers**: {Reviewers joined by commas}
132-
133-
### Summary
134-
{Summary limited to 50 words}
135-
136-
### Recent Activity
137-
{List last 3 comments with username and content}
118+
Use the <overall_instructions> to guide the content of the summary. Use the format shown in <example> but do not include or refer the example's content in the final summary/report.
119+
120+
<overall_instructions>
121+
Generate a summary of each pull request in the following bullet point format:
122+
123+
- PR Link: Provide a hyperlink to the pull request from the 'URL:' value
124+
- Title: Provide the value of the 'Title:' field
125+
- PR State: Provide the state of the PR based on the following conditions:
126+
- If 'Merged: true' set 'PR State: 🔀 Merged'
127+
- Else If 'Draft: true' set 'PR State: 📝 Draft'
128+
- Else If 'State: open' or 'State: active' set 'PR State: 💬 Open'
129+
- Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
130+
- Else set 'PR State: ❓ Unknown'
131+
- If the PR is stale, add '⚠️ Stale' at the end of the PR State.
132+
- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
133+
- Summary: In under 50 words provide a short summary of the PR.
134+
- Comments: In under 50 words provide a short summary of all comments found within <pr_comments>, including each comments author username from <comment_author_username>. If there are no comments available, output 'No comments'.
135+
</overall_instructions>
136+
137+
<example>
138+
- **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001)
139+
- **Title:** [PR Title]
140+
- **PR State:** 💬 Open
141+
- **Mergeable:** Mergeable
142+
- **Summary:** [Summary of the PR].
143+
- **Comments:** [Summary of the PR comments].
144+
145+
- **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
146+
- **Title:** [PR Title]
147+
- **PR State:** 💬 Open
148+
- **Mergeable:** Mergeable
149+
- **Summary:** [Summary of the PR].
150+
- **Comments:** [Summary of the PR comments].
151+
152+
- **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3)
153+
- **Title:** [PR Title]
154+
- **PR State:** 🔀 Merged
155+
- **Summary:** [Summary of the PR].
156+
- **Comments:** [Summary of the PR comments].
157+
158+
- **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14)
159+
- **Title:** [PR Title]
160+
- **PR State:** 💬 Open
161+
- **Mergeable:** Mergeable
162+
- **Summary:** [Summary of the PR].
163+
- **Comments:** [Summary of the PR comments].
164+
165+
- **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
166+
- **Title:** [PR Title]
167+
- **PR State:** 🔀 Merged
168+
- **Summary:** [Summary of the PR].
169+
- **Comments:** [Summary of the PR comments].
170+
171+
- **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
172+
- **Title:** [PR Title]
173+
- **PR State:** 🔀 Merged
174+
- **Summary:** [Summary of the PR].
175+
- **Comments:** [Summary of the PR comments].
176+
177+
- **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
178+
- **Title:** [PR Title]
179+
- **PR State:** 📝 Draft
180+
- **Mergeable:** Not Mergeable
181+
- **Summary:** [Summary of the PR].
182+
- **Comments:** [Summary of the PR comments].
183+
</example>
138184
```
139185

140186
### Formatting Options

0 commit comments

Comments
 (0)