Skip to content

Commit 2ca08a2

Browse files
adding example in for consistency (#229)
* adding example in for consistency * fix example
1 parent 2e13b76 commit 2ca08a2

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

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

+41
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,47 @@ Provide:
236236
- Help maintain consistency across teams
237237
- Avoid ambiguity in report generation
238238

239+
Try to use `<overall_summary>` and `<example>` tag blocks to keep consistency across reports:
240+
241+
```text
242+
Use the <overall_instructions> to guide the content of the summary and base the formatting of the summary on the <example>. Be sure to change the PR link based on the platform of the repository.
243+
244+
<overall_instructions>
245+
Generate a summary of each pull request in the following bullet point format:
246+
247+
- PR Link
248+
- Title
249+
- PR State: Provide the state of the PR based on the following conditions:
250+
- If 'Merged: true' set 'PR State: 🔀 Merged'
251+
- Else If 'Draft: true' set 'PR State: 📝 Draft'
252+
- Else If 'State: open' set 'PR State: 💬 Open'
253+
- Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
254+
- Else set 'PR State: ❓ Unknown'
255+
- If the PR is stale, add '⚠️ Stale' at the end of the PR State.
256+
- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
257+
- Summary: Provide a short summary of the PR under 50 words.
258+
</overall_instructions>
259+
260+
<example>
261+
- **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001)
262+
- **Title:** feat: Add Dynamic Theme Switching Feature
263+
- **PR State:** 💬 Open
264+
- **Mergeable:** Mergeable
265+
- **Summary:** Introduces dynamic theme switching to improve UI accessibility. Adds support for dark/light mode toggling and updates color schemes across the application for an enhanced user experience.
266+
267+
- **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3)
268+
- **Title:** Chore: Update Third-Party Dependencies for Security Enhancements
269+
- **PR State:** 🔀 Merged
270+
- **Summary:** Updates several third-party dependencies to address security vulnerabilities and improve performance. Includes minor bug fixes and adjustments to maintain compatibility with the latest libraries.
271+
272+
- **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
273+
- **Title:** 📝 Draft: Prototype New Analytics Dashboard
274+
- **PR State:** 📝 Draft
275+
- **Mergeable:** Not Mergeable
276+
- **Summary:** Initiates a prototype for a new analytics dashboard designed to provide users with real-time insights. This draft version is open for early feedback and may undergo significant changes based on review and testing. Requires update from the main branch to be mergable.
277+
</example>
278+
```
279+
239280
## Example Templates
240281

241282
### Executive Summary Template

0 commit comments

Comments
 (0)