Skip to content

adding example in for consistency #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 13, 2025
Merged

adding example in for consistency #229

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8dd62be
adding example in for consistency
alexcoderabbitai Feb 13, 2025
927f208
fix example
alexcoderabbitai Feb 13, 2025
d2d6918
fix example
alexcoderabbitai Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/guides/custom-reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,47 @@ Provide:
- Help maintain consistency across teams
- Avoid ambiguity in report generation

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.

<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:** [#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.

- **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
Expand Down