-
Notifications
You must be signed in to change notification settings - Fork 48
Migrate GitHub issue templates from Markdown to YAML #3635
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
base: master
Are you sure you want to change the base?
Conversation
- Replace legacy .md templates with structured .yml forms for bug reports, feature requests, and tasks. Add new epic template and disable blank issues.
WalkthroughThe changes migrate GitHub issue templates from markdown format (.md files) to YAML format (.yml files) across the project. Three old markdown templates (bug_report.md, feature_request.md, task.md) are removed and replaced with structured YAML equivalents (bug_report.yml, feature-request.yml, epic.yml). A configuration file (config.yml) is added to disable blank issue creation, enforcing the use of defined templates. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
|
🚀 Deployed on https://deploy-preview-3635--glific-frontend.netlify.app |
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: 0
🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/bug_report.yml (1)
12-17: Add missingidattribute for consistency.The "Steps to Reproduce" field lacks an
idattribute, while all other fields in this template (and across other templates) have one. This creates an inconsistency that could complicate future automation or maintenance.Apply this diff to add the missing ID:
- type: textarea + id: steps-to-reproduce attributes: label: Steps to Reproduce description: Step by step guide to reproduce the bug
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.github/ISSUE_TEMPLATE/bug_report.md(0 hunks).github/ISSUE_TEMPLATE/bug_report.yml(1 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks).github/ISSUE_TEMPLATE/epic.yml(1 hunks).github/ISSUE_TEMPLATE/feature-request.yml(1 hunks).github/ISSUE_TEMPLATE/feature_request.md(0 hunks).github/ISSUE_TEMPLATE/task.md(0 hunks)
💤 Files with no reviewable changes (3)
- .github/ISSUE_TEMPLATE/feature_request.md
- .github/ISSUE_TEMPLATE/bug_report.md
- .github/ISSUE_TEMPLATE/task.md
⏰ 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). (4)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: build
- GitHub Check: glific (1.18.3-otp-27, 27.3.3)
- GitHub Check: CI
🔇 Additional comments (4)
.github/ISSUE_TEMPLATE/config.yml (1)
1-1: Good enforcement of structured issue templates.Setting
blank_issues_enabled: falseensures all issues use defined templates, which aligns with the migration to structured YAML forms..github/ISSUE_TEMPLATE/epic.yml (1)
1-23: Solid template structure with appropriate required fields.The Epic template is well-designed with three essential required fields (summary, PRD link, tech design doc link) that establish clear tracking requirements for epic features. Field IDs are consistently named and YAML structure is valid.
.github/ISSUE_TEMPLATE/bug_report.yml (1)
1-45: Well-structured bug report template with logical field progression.The template covers the essential elements of effective bug reporting: summary, reproduction steps, expected vs. actual behavior, acceptance criteria, and supporting screenshots. The progression is logical and will help reporters provide complete information.
.github/ISSUE_TEMPLATE/feature-request.yml (1)
1-39: Comprehensive and consistently structured feature request template.The template balances required and optional fields well, with three essential fields (summary, requirements, acceptance criteria) providing clear definition requirements, and two optional fields (screenshots, notes) allowing for supporting details. All fields have consistent IDs, and the placeholder example enhances usability.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3635 +/- ##
=======================================
Coverage 82.55% 82.56%
=======================================
Files 341 341
Lines 11424 11424
Branches 2418 2418
=======================================
+ Hits 9431 9432 +1
Misses 1259 1259
+ Partials 734 733 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Ticket #3634
Screenshots
Bug Report
Feature Request
Epic