Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 927f208

Browse files
fix example
1 parent 8dd62be commit 927f208

File tree

1 file changed

+4
-27
lines changed

1 file changed

+4
-27
lines changed

docs/guides/custom-reports.md

+4-27
Original file line numberDiff line numberDiff line change
@@ -236,11 +236,10 @@ Provide:
236236
- Help maintain consistency across teams
237237
- Avoid ambiguity in report generation
238238

239-
- Try to use an <overall_summary> and <example> tag blocks to keep consistency across reports. EX:
239+
Try to use `<overall_summary>` and `<example>` tag blocks to keep consistency across reports:
240240

241-
```text
242-
243-
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.
241+
```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.
244243
245244
<overall_instructions>
246245
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:
265264
- **Mergeable:** Mergeable
266265
- **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.
267266
268-
- **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
269-
- **Title:** Fix: Correct Typographical Error in Dashboard Header
270-
- **PR State:** 💬 Open
271-
- **Mergeable:** Mergeable
272-
- **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.
273-
274267
- **PR Link:** [#3003](https://github.com/mygithuborg/myotherrepo/pull/3)
275268
- **Title:** Chore: Update Third-Party Dependencies for Security Enhancements
276269
- **PR State:** 🔀 Merged
277270
- **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.
278271
279-
- **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14)
280-
- **Title:** Refactor: Simplify Data Fetching Logic in User Profiles Module
281-
- **PR State:** 💬 Open
282-
- **Mergeable:** Mergeable
283-
- **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.
284-
285-
- **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
286-
- **Title:** feat: Integrate Real-Time Notifications for Activity Updates
287-
- **PR State:** 🔀 Merged
288-
- **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.
289-
290-
- **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
291-
- **Title:** Hotfix: Address Issue with API Rate Limiting on Login Endpoint
292-
- **PR State:** 🔀 Merged
293-
- **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.
294-
295272
- **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
296273
- **Title:** 📝 Draft: Prototype New Analytics Dashboard
297274
- **PR State:** 📝 Draft
298275
- **Mergeable:** Not Mergeable
299276
- **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.
300277
</example>
301-
```
278+
```
302279

303280
## Example Templates
304281

0 commit comments

Comments
 (0)