Skip to content

Commit 83ee4b7

Browse files
Add a new custom report (#209)
* add good day release report * fix title
1 parent 1788c2c commit 83ee4b7

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

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

+54-1
Original file line numberDiff line numberDiff line change
@@ -274,10 +274,63 @@ Include:
274274
- Technical debt analysis
275275
```
276276

277-
### Advanced Formatting
277+
## Advanced Example Templates
278278

279279
Heres a more advanced example of a custom report template:
280280

281+
### **Good Day Release Report**
282+
283+
```text
284+
**GPT Specialization:**
285+
This GPT specializes in summarizing software release notes and optional summary paragraphs into a consistent, clear, and concise format. The goal is to streamline the presentation of release notes, making them easy to understand for a general audience. It prioritizes clarity, brevity, and coherence while highlighting important updates without unnecessary jargon.
286+
287+
**Release Note Structure:**
288+
289+
1. **Release Notes Organization**
290+
The items in the release notes may not be in the desired order. It is crucial to group similar items together meaningfully. Review the list after the release notes are created and reorder items within each heading based on relevance. Use **PRODUCT FEATURE GROUPS** to understand which items are related.
291+
292+
2. **General Release Note Guidelines**
293+
- The title should be: `GoodDay Release v${versionNumber}`
294+
295+
3. **Release Note Line Items**
296+
- Reword individual release lines to maintain a consistent tone (happy and fun)
297+
- Use past tense for descriptions
298+
- Items in the 🧼 Fixes group should begin with "Fixed"
299+
- Consolidate duplicate or closely related items, and list the associated GitHub pull requests as a comma-delimited list at the end (e.g., GH-123, GH-456)
300+
- Add links to Github App for each PR
301+
302+
4. **GitHub App Links**
303+
- each pr mentioned should include hyperlinking to the pull request such as [coderabbitai/mono/pull/2614](https://github.com/coderabbitai/mono/pull/2614)
304+
305+
5. **Grouping Release Note Line Items**
306+
- Replace any emoji in the provided content with the appropriate **RELEASE NOTE GROUP**
307+
- Order the **RELEASE NOTE GROUP** according to the structure below
308+
309+
6. **Release Note Groups**
310+
- 🚀 **Features**: New capabilities or enhancements
311+
- 🧼 **Fixes**: Bug fixes or problem resolutions
312+
- 🧰 **Maintenance**: Documentation, cleanup, or technical changes
313+
- 📚 **Other**: Anything else
314+
315+
7. **PR Label Uses**
316+
- Omit any PRs with the label `skip-changelog`
317+
- Use the labels from related pull requests to group items together
318+
- Map PR labels to release note groups using the table below:
319+
320+
| RELEASE NOTE GROUP | LABELS |
321+
|--------------------|-----------------|
322+
| 🚀 Features | feature, enhancement |
323+
| 🧼 Fixes | bug, fix |
324+
| 🧰 Maintenance | design, docs |
325+
| 📚 Other | other, tech |
326+
327+
8. **Final Checks**
328+
- Verify that the number of items matches the number of PRs included
329+
- Ensure the PR links match the PR number and reflect the content of the changes
330+
```
331+
332+
### **Nato's Special Report**
333+
281334
```text
282335
Generate a report of all pull requests in the following format:
283336

0 commit comments

Comments
 (0)