docs/guides/custom-reports.md (4)

302-303:Make the GitHub link example generic.

The example uses a specific repository pathcoderabbitai/mono/pull/2614. Consider using a generic example to make it more universally applicable.

-   - each pr mentioned should include hyperlinking to the pull request such as [coderabbitai/mono/pull/2614](https://github.com/coderabbitai/mono/pull/2614)+   - each pr mentioned should include hyperlinking to the pull request such as [owner/repo/pull/123](https://github.com/owner/repo/pull/123)

---

293-293:Clarify the version number format.

The title format uses template literals (${versionNumber}). Consider providing an example of the expected format to avoid confusion.

-   - The title should be: `GoodDay Release v${versionNumber}`+   - The title should be: `GoodDay Release v${versionNumber}` (e.g., "GoodDay Release v1.2.3")

---

310-313:Consider adding alt-text for emojis.

For better accessibility, consider adding text descriptions alongside the emojis in the release note groups.

-   - 🚀 **Features**: New capabilities or enhancements-   - 🧼 **Fixes**: Bug fixes or problem resolutions-   - 🧰 **Maintenance**: Documentation, cleanup, or technical changes-   - 📚 **Other**: Anything else+   - 🚀 (Rocket) **Features**: New capabilities or enhancements+   - 🧼 (Soap) **Fixes**: Bug fixes or problem resolutions+   - 🧰 (Toolbox) **Maintenance**: Documentation, cleanup, or technical changes+   - 📚 (Books) **Other**: Anything else

---

332-333:Enhance accessibility of status indicators.

The colored circles (🟣, ⚫, 🟢, 🔴) used for PR status might not be accessible to all users. Consider adding text descriptions.

- start with "🟣" if merged, "⚫" if draft, "🟢" if open, "🔴" if closed+ start with one of these status indicators:+   - "🟣 [Merged]" for merged PRs+   - "⚫ [Draft]" for draft PRs+   - "🟢 [Open]" for open PRs+   - "🔴 [Closed]" for closed PRs

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

docs/guides/custom-reports.md (6)

279-279:Fix grammatical error in the introduction.

Add an apostrophe to "Heres".

-Heres a more advanced example of a custom report template:+Here's a more advanced example of a custom report template:

---

293-293:Clarify version number format.

The template literal syntax${versionNumber} might not be clear to all users. Consider using a more explicit placeholder format.

-   - The title should be: `GoodDay Release v${versionNumber}`+   - The title should be: `GoodDay Release v[VERSION_NUMBER]` (e.g., `GoodDay Release v1.2.3`)

---

302-303:Enhance GitHub App links section with format examples.

The GitHub App links section could be more specific about the expected format and include multiple examples.

 4. **GitHub App Links**-   - each pr mentioned should include hyperlinking to the pull request such as [coderabbitai/mono/pull/2614](https://github.com/coderabbitai/mono/pull/2614)+   - Each PR mentioned should include hyperlinking to the pull request using the following format:+     - Single PR: [org/repo/pull/123](https://github.com/org/repo/pull/123)+     - Multiple PRs: [org/repo/pull/123](https://github.com/org/repo/pull/123), [org/repo/pull/456](https://github.com/org/repo/pull/456)

---

320-325:Expand PR label mapping table with common labels.

Consider adding more common labels to make the mapping more comprehensive.

 | RELEASE NOTE GROUP | LABELS          | |--------------------|-----------------|-| 🚀 Features        | feature, enhancement |-| 🧼 Fixes           | bug, fix        |-| 🧰 Maintenance     | design, docs    |-| 📚 Other           | other, tech     |+| 🚀 Features        | feature, enhancement, new-feature |+| 🧼 Fixes           | bug, fix, bugfix, hotfix |+| 🧰 Maintenance     | design, docs, documentation, refactor, cleanup |+| 📚 Other           | other, tech, chore, dependencies |

---

332-333:Add a descriptive introduction for Nato's Special Report.

The template would benefit from a brief introduction explaining its purpose and when to use it.

 ### **Nato's Special Report**++This template specializes in generating concise, standardized summaries of pull requests with a focus on high-level changes and current blockers. It's particularly useful for status updates and team synchronization. ```text

Also applies to: 334-335

---

Line range hint334-337:Clarify timezone format in date specifications.

The date format specification should be more explicit about the timezone format.

 - As the first paragraph, start with "🟣" if merged, "⚫" if draft, "🟢" if open, "🔴" if closed   - On the same line, add the PR title in bold (and only the title; don't put anything else in bold after that)   - On the same line, add the PR browser link (do not use an api link)-  - On the same line, add the last activity date in the format "Day Month Year, Hour:Minute AM/PM (Timezone)" in italic+  - On the same line, add the last activity date in the format "Day Month Year, Hour:Minute AM/PM (UTC±XX:XX)" in italic (e.g., "15 Jan 2025, 02:30 PM (UTC-05:00)")

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro