Skip to content

Commit 1bad3dd

Browse files
use a simple example and add hyperlink (#233)
1 parent 18f729f commit 1bad3dd

File tree

1 file changed

+25
-30
lines changed

1 file changed

+25
-30
lines changed

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

+25-30
Original file line numberDiff line numberDiff line change
@@ -236,44 +236,39 @@ Provide:
236236
- Help maintain consistency across teams
237237
- Avoid ambiguity in report generation
238238

239+
### Add Examples for Consistent Formatting
240+
239241
Try to use `<overall_summary>` and `<example>` tag blocks to keep consistency across reports:
240242

241243
```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.
244+
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.
243245
244246
<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.
247+
Generate release notes with the following sections:
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 and don't affect the end-user.
256+
Use a single level of bullet points for each change.
257+
Don't add links to the PRs.
258+
Do not add a list of pull requests.
259+
Do not show a random release date, version, etc. if they are not known.
258260
</overall_instructions>
259261
260262
<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.
263+
## Summary
264+
[Summary of the release]
265+
266+
## Changes
267+
- [Summary of the change 1]
268+
- [Summary of the change 2]
269+
- [Summary of the change 3]
270+
- ...
271+
- [Summary of the change N]
277272
</example>
278273
```
279274

0 commit comments

Comments
 (0)