use a simple example and add hyperlink (#233)

alexcoderabbitai · web-flow · commit 1bad3dd4e1be · 2025-02-18T10:43:47.000-05:00
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
@@ -236,44 +236,39 @@ Provide:
    - Help maintain consistency across teams
    - Avoid ambiguity in report generation
 
+### Add Examples for Consistent Formatting
+
 Try to use `<overall_summary>` and `<example>` tag blocks to keep consistency across reports:
 
 ```text
-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.
+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.
 
 <overall_instructions>
-Generate a summary of each pull request in the following bullet point format:
-
-- PR Link
-- Title
-- PR State: Provide the state of the PR based on the following conditions:
-  - If 'Merged: true' set 'PR State: 🔀 Merged'
-  - Else If 'Draft: true' set 'PR State: 📝 Draft'
-  - Else If 'State: open' set 'PR State: 💬 Open'
-  - Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
-  - Else set 'PR State: ❓ Unknown'
-  - If the PR is stale, add '⚠️ Stale' at the end of the PR State.
-- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
-- Summary: Provide a short summary of the PR under 50 words.
+Generate release notes with the following sections:
+
+- Summary: A high-level summary of the overall change instead of specific files within 100 words.
+- Changes: A bullet point list of all the significant changes made in this release.
+
+Significant changes include new features, bug fixes, and other notable changes.
+Use a single sentence for each change without headings or categorization.
+Do not include changes from PRs that have not been merged.
+Don't show changes that are too insignificant and don't affect the end-user.
+Use a single level of bullet points for each change.
+Don't add links to the PRs.
+Do not add a list of pull requests.
+Do not show a random release date, version, etc. if they are not known.
 </overall_instructions>
 
 <example>
-- **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001)
-- **Title:** feat: Add Dynamic Theme Switching Feature
-- **PR State:** 💬 Open
-- **Mergeable:** Mergeable
-- **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.
-
-- **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3)
-- **Title:** Chore: Update Third-Party Dependencies for Security Enhancements
-- **PR State:** 🔀 Merged
-- **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.
-
-- **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
-- **Title:** 📝 Draft: Prototype New Analytics Dashboard
-- **PR State:** 📝 Draft
-- **Mergeable:** Not Mergeable
-- **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.
+## Summary
+[Summary of the release]
+
+## Changes
+- [Summary of the change 1]
+- [Summary of the change 2]
+- [Summary of the change 3]
+- ...
+- [Summary of the change N]
 </example>
 ```
 
