-
Notifications
You must be signed in to change notification settings - Fork 2
Add preview section to pull request template #472
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.
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
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughAdded a new repository pull request template file at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes No logic or executable code; review can focus on wording and formatting of the template. Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-7: Consider enhancing the template with additional guidance.The template structure is sound, but you may want to add brief instructional text or examples within each section to guide contributors on what information is expected. For instance, the "Preview" section could include a note like "Screenshots, output samples, or other visual previews (if applicable):" to clarify its purpose.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
.github/PULL_REQUEST_TEMPLATE.md
7-7: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build docs
Co-authored-by: Andreas Motl <[email protected]>
Co-authored-by: Andreas Motl <[email protected]>
Summary of the changes / Why this is an improvement
New tailored PR template with "Preview" section added.