Skip to content

Conversation

@shijithkjayan
Copy link
Member

@shijithkjayan shijithkjayan commented Nov 20, 2025

Ticket #3634

Screenshots

Bug Report

image

Feature Request

Screenshot 2025-11-20 at 12 31 43 AM

Epic

Screenshot 2025-11-20 at 12 37 52 AM

- Replace legacy .md templates with structured .yml forms for bug
reports, feature requests, and tasks. Add new epic template and disable
blank issues.
@coderabbitai
Copy link

coderabbitai bot commented Nov 20, 2025

Walkthrough

The 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

  • Verify YAML syntax correctness across all new template files
  • Confirm that field definitions (required, placeholders, labels) match the intended workflow
  • Ensure the config.yml setting aligns with repository policies for issue management

Poem

🐰 From markdown old to YAML bright,
Our templates now structure just right!
Bug reports flow, features gleam,
Guided forms fulfill the dream,
No blank issues found—just guided delight! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: migrating issue templates from Markdown (.md) format to YAML (.yml) format, which is exactly what the changeset implements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch use-issue-forms-for-issue-templates

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

@github-actions github-actions bot temporarily deployed to pull request November 20, 2025 06:26 Inactive
Copy link

@coderabbitai coderabbitai bot left a 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 missing id attribute for consistency.

The "Steps to Reproduce" field lacks an id attribute, 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

📥 Commits

Reviewing files that changed from the base of the PR and between c7c6dba and 137c764.

📒 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: false ensures 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
Copy link

codecov bot commented Nov 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.56%. Comparing base (c7c6dba) to head (137c764).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace markdown issue templates with structured YAML-based GitHub Issue Forms

3 participants