From 8dd62bec35f4de6d90f164fc22673fb7da0a77b5 Mon Sep 17 00:00:00 2001
From: alex <alex@coderabbit.ai>
Date: Thu, 13 Feb 2025 11:08:43 -0500
Subject: [PATCH 1/3] adding example in for consistency
---
docs/guides/custom-reports.md | 64 +++++++++++++++++++++++++++++++++++
1 file changed, 64 insertions(+)
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
index 11581b38..1a402951 100644
--- a/docs/guides/custom-reports.md
+++ b/docs/guides/custom-reports.md
@@ -236,6 +236,70 @@ Provide:
- Help maintain consistency across teams
- Avoid ambiguity in report generation
+- Try to use an <overall_summary> and <example> tag blocks to keep consistency across reports. EX:
+
+ ```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. We cover Github, Gitlab, Azure DevOps, Bitbucket and self hosted platforms.
+
+<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.
+</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:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
+- **Title:** Fix: Correct Typographical Error in Dashboard Header
+- **PR State:** 💬 Open
+- **Mergeable:** Mergeable
+- **Summary:** Corrects a minor typographical error in the dashboard header to ensure consistency in UI labels. This update refines the display text and improves overall clarity.
+
+- **PR Link:** [#3003](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:** [#14](https://github.com/mygithuborg/frontend/pull/14)
+- **Title:** Refactor: Simplify Data Fetching Logic in User Profiles Module
+- **PR State:** 💬 Open
+- **Mergeable:** Mergeable
+- **Summary:** Refactors the data fetching logic in the user profiles module by replacing nested callbacks with async/await. Enhances code readability and streamlines error handling for a more robust implementation.
+
+- **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
+- **Title:** feat: Integrate Real-Time Notifications for Activity Updates
+- **PR State:** 🔀 Merged
+- **Summary:** Implements real-time notifications to keep users updated on recent activities. Utilizes WebSocket connections for instant alerts and provides customizable notification settings within the user profile.
+
+- **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
+- **Title:** Hotfix: Address Issue with API Rate Limiting on Login Endpoint
+- **PR State:** 🔀 Merged
+- **Summary:** Applies a hotfix to resolve issues related to API rate limiting on the login endpoint. Adjusts configuration parameters and enhances error responses to ensure smoother authentication during peak usage.
+
+- **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.
+</example>
+ ```
+
## Example Templates
### Executive Summary Template
From 927f208676dabbfc5f315a871505bd8961f21270 Mon Sep 17 00:00:00 2001
From: alex <alex@coderabbit.ai>
Date: Thu, 13 Feb 2025 11:17:14 -0500
Subject: [PATCH 2/3] fix example
---
docs/guides/custom-reports.md | 31 ++++---------------------------
1 file changed, 4 insertions(+), 27 deletions(-)
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
index 1a402951..5dd982c7 100644
--- a/docs/guides/custom-reports.md
+++ b/docs/guides/custom-reports.md
@@ -236,11 +236,10 @@ Provide:
- Help maintain consistency across teams
- Avoid ambiguity in report generation
-- Try to use an <overall_summary> and <example> tag blocks to keep consistency across reports. EX:
+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. We cover Github, Gitlab, Azure DevOps, Bitbucket and self hosted platforms.
+```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.
<overall_instructions>
Generate a summary of each pull request in the following bullet point format:
@@ -265,40 +264,18 @@ Generate a summary of each pull request in the following bullet point format:
- **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:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
-- **Title:** Fix: Correct Typographical Error in Dashboard Header
-- **PR State:** 💬 Open
-- **Mergeable:** Mergeable
-- **Summary:** Corrects a minor typographical error in the dashboard header to ensure consistency in UI labels. This update refines the display text and improves overall clarity.
-
- **PR Link:** [#3003](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:** [#14](https://github.com/mygithuborg/frontend/pull/14)
-- **Title:** Refactor: Simplify Data Fetching Logic in User Profiles Module
-- **PR State:** 💬 Open
-- **Mergeable:** Mergeable
-- **Summary:** Refactors the data fetching logic in the user profiles module by replacing nested callbacks with async/await. Enhances code readability and streamlines error handling for a more robust implementation.
-
-- **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
-- **Title:** feat: Integrate Real-Time Notifications for Activity Updates
-- **PR State:** 🔀 Merged
-- **Summary:** Implements real-time notifications to keep users updated on recent activities. Utilizes WebSocket connections for instant alerts and provides customizable notification settings within the user profile.
-
-- **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
-- **Title:** Hotfix: Address Issue with API Rate Limiting on Login Endpoint
-- **PR State:** 🔀 Merged
-- **Summary:** Applies a hotfix to resolve issues related to API rate limiting on the login endpoint. Adjusts configuration parameters and enhances error responses to ensure smoother authentication during peak usage.
-
- **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.
</example>
- ```
+```
## Example Templates
From d2d69189baf5c947c756af0697a3080b8b8f16ca Mon Sep 17 00:00:00 2001
From: alex <alex@coderabbit.ai>
Date: Thu, 13 Feb 2025 11:54:20 -0500
Subject: [PATCH 3/3] fix example
---
docs/guides/custom-reports.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
index 5dd982c7..c3100eb3 100644
--- a/docs/guides/custom-reports.md
+++ b/docs/guides/custom-reports.md
@@ -264,7 +264,7 @@ Generate a summary of each pull request in the following bullet point format:
- **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:** [#3003](https://github.com/mygithuborg/myotherrepo/pull/3)
+- **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.