You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/guides/custom-reports.md
+25-30Lines changed: 25 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -236,44 +236,39 @@ Provide:
236
236
- Help maintain consistency across teams
237
237
- Avoid ambiguity in report generation
238
238
239
+
###Add Examples for Consistent Formatting
240
+
239
241
Try to use`<overall_summary>` and`<example>` tag blocks to keep consistency across reports:
240
242
241
243
```text
242
-
Use the <overall_instructions> to guide the content of the summary and basetheformatting of the summary on the<example>. Be sure to change the PR link based ontheplatform oftherepository.
244
+
Use the <overall_instructions> to guide the content of the summary. Usetheformat shown in<example> but do not include or refertheexample's content inthefinal summary/report.
243
245
244
246
<overall_instructions>
245
-
Generatea summary of each pull request inthe followingbullet 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' attheend of the PR State.
256
-
- Mergeable (if PR State ifnot'Merged'): Provide the mergeable statusofthe PR as 'Mergeable' or 'Not Mergeable'.
257
-
- Summary: Provide ashort summary of the PR under 50 words.
247
+
Generaterelease notes withthe followingsections:
248
+
249
+
-Summary: A high-level summary of the overall change instead of specific files within 100 words.
250
+
-Changes: A bullet point list of all the significant changes made in this release.
251
+
252
+
Significant changes include new features, bug fixes, and other notable changes.
253
+
Use a single sentence for each change without headings or categorization.
254
+
Do not include changes from PRs that have not been merged.
255
+
Don't show changes that are too insignificant anddon't affect the end-user.
256
+
Use a single level of bullet points for each change.
257
+
Don'taddlinks tothePRs.
258
+
Donotadd a listofpull requests.
259
+
Do not show arandom release date, version, etc. if they are not known.
- **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.
- **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.
- **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.