Update and improve issue templates #129

mkh-user · 2025-11-19T17:10:19Z

Description

Update issue templates to new GitHub issue templates system with .yml files and some new templates.

Testing

Tested in private repository.

Impact

Nothing

Additional Information

Nothing

Checklist

My code adheres to the coding and style guidelines of the project.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings
Changes were added to CHANGELOG

Summary by CodeRabbit

Documentation
- Replaced legacy markdown issue templates with new structured, form-style issue templates for bugs, features, docs, localization, planned features, and questions.
- Added guided sections, required fields, and helpful placeholders to improve report quality.
Chores
- Disabled blank issue creation and added contact links for community support, contribution guide, documentation, and security reporting.

coderabbitai · 2025-11-19T17:14:27Z

Walkthrough

Repository issue templates were migrated from Markdown to YAML form templates: several .md files were removed and replaced by structured .yml templates; additional YAML templates were added; and a central config.yml for issue template behavior and contact links was introduced.

Changes

Cohort / File(s)	Change Summary
Bug Report `.github/ISSUE_TEMPLATE/*` `\`.github/ISSUE_TEMPLATE/bug_report.md``,` `.github/ISSUE_TEMPLATE/bug_report.yml``	Removed the markdown bug report template and added a YAML form template that collects structured bug details, reproduction steps, required final review, and optional screenshots/metadata.
Feature Request `\`.github/ISSUE_TEMPLATE/feature_request.md``,` `.github/ISSUE_TEMPLATE/feature_request.yml``	Removed the markdown feature-request template and added a YAML form template with required motivation/proposal fields, optional alternatives/context, and a Code of Conduct checkbox.
Planned Feature `\`.github/ISSUE_TEMPLATE/planned-feature.md``,` `.github/ISSUE_TEMPLATE/planned_feature.yml``	Removed the markdown planned-feature template and added a YAML form template enforcing developer eligibility checks and required summary/motivation/design sections.
Documentation / Localization / Question `\`.github/ISSUE_TEMPLATE/docs_issue.yml``,` `.github/ISSUE_TEMPLATE/localization_issue.yml``,` `.github/ISSUE_TEMPLATE/question.yml``	Added three new YAML form templates for docs issues, localization reports, and general questions with multi-step forms and required pre-checks and final review.
Template Configuration `\`.github/ISSUE_TEMPLATE/config.yml``	Added issue template configuration that disables blank issues and provides contact_links (Community Support, Contribution Guide, Documentation Website).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User as Reporter
  participant GH as GitHub UI
  participant Templates as .github/ISSUE_TEMPLATE
  participant Config as config.yml

  Note over GH,Templates: Issue creation flow (new)
  User->>GH: Click "New issue"
  GH->>Config: Read config (disable blank issues, contact links)
  GH->>Templates: Present list of YAML form templates
  Templates-->>GH: Provide selected form (fields, required validations)
  GH->>User: Render form (checkboxes, textareas, dropdowns)
  User->>GH: Submit form
  GH->>Templates: Create issue populated with form data
  GH->>User: Confirm issue created

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Review attention:
- Verify required vs optional fields in each .yml (bug_report.yml, feature_request.yml, planned_feature.yml).
- Confirm consistency of step numbering, labels, placeholders, and Code of Conduct checkbox across templates.
- Validate config.yml contact_links URLs and that disabling blank issues aligns with repository workflow.

Poem

🐰 From markdown burrows to YAML bright,
Forms hop in rows, all tidy and right.
Checkboxes, fields, a structured song —
Report, request, or question — hop along! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: updating and improving GitHub issue templates from markdown to YAML format with new templates added.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch new-issue-templates

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 544c51d and 96195ed.

📒 Files selected for processing (2)

.github/ISSUE_TEMPLATE/config.yml (1 hunks)
.github/ISSUE_TEMPLATE/question.yml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.github/ISSUE_TEMPLATE/config.yml

🔇 Additional comments (2)

.github/ISSUE_TEMPLATE/question.yml (2)

27-40: YAML nesting corrected; structure is now valid.

The validations key is correctly positioned as a sibling of attributes at the same indentation level (4 spaces) for both textarea fields. The previous critical nesting issue has been resolved.

1-51: Template structure is well-organized and follows GitHub schema.

The support template flows logically through pre-checks → user input → consent review. The required fields (search pre-check, main question, Code of Conduct agreement) and optional context textarea are appropriately configured. The placeholder example at line 32 is specific and helpful for guiding users.

One minor observation: the Code of Conduct link at line 48 capitalizes the branch name as "Main" — please verify this matches your repository's actual branch naming convention.

Please confirm that the branch reference Main at line 48 is correct for your repository.

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.}

coderabbitai

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6a293d and 544c51d.

📒 Files selected for processing (10)

.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/docs_issue.yml (1 hunks)
.github/ISSUE_TEMPLATE/feature_request.md (0 hunks)
.github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
.github/ISSUE_TEMPLATE/localization_issue.yml (1 hunks)
.github/ISSUE_TEMPLATE/planned-feature.md (0 hunks)
.github/ISSUE_TEMPLATE/planned_feature.yml (1 hunks)
.github/ISSUE_TEMPLATE/question.yml (1 hunks)

💤 Files with no reviewable changes (3)

.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/planned-feature.md
.github/ISSUE_TEMPLATE/bug_report.md

🔇 Additional comments (5)

.github/ISSUE_TEMPLATE/config.yml (1)

1-14: Verify the default branch name in contact links.

The CONTRIBUTING.md link (line 7) references the branch name as "Main" (capitalized). Confirm that this matches your repository's actual default branch name to avoid 404 errors when users click this link.

.github/ISSUE_TEMPLATE/docs_issue.yml (1)

1-71: Template structure looks good.

The documentation issue template is well-structured with clear sections, helpful placeholders, and appropriate field requirements. YAML syntax is valid and consistent.

.github/ISSUE_TEMPLATE/localization_issue.yml (1)

29-39: Verify the language dropdown covers all supported locales.

The language dropdown (lines 29-39) lists only English, Persian, Polish, and Other. Confirm this matches your project's actual translation coverage. If more languages are supported or planned, consider adding them to improve discoverability.

.github/ISSUE_TEMPLATE/bug_report.yml (1)

1-143: Template is well-structured and comprehensive.

The bug report template has clear sections, appropriate field validation, correct dropdown default indices, and helpful placeholder text. Checkbox validation is correctly specified at the option level, consistent with other templates.

.github/ISSUE_TEMPLATE/feature_request.yml (1)

1-71: Template structure and field validation are correct.

The feature request template has proper YAML structure, appropriate field requirements, and clear descriptions. Validation nesting is correct and consistent with other templates in this PR.

.github/ISSUE_TEMPLATE/localization_issue.yml

.github/ISSUE_TEMPLATE/planned_feature.yml

.github/ISSUE_TEMPLATE/question.yml

update and improve issue templates

544c51d

mkh-user added this to the Text Forge 0.2 milestone Nov 19, 2025

mkh-user self-assigned this Nov 19, 2025

mkh-user added this to Release: Text Forge 1.0 Nov 19, 2025

github-project-automation bot moved this to Needs Review in Release: Text Forge 1.0 Nov 19, 2025

mkh-user removed the status in Release: Text Forge 1.0 Nov 19, 2025

mkh-user moved this to In Progress in Release: Text Forge 1.0 Nov 19, 2025

coderabbitai bot reviewed Nov 19, 2025

View reviewed changes

.github/ISSUE_TEMPLATE/localization_issue.yml Show resolved Hide resolved

.github/ISSUE_TEMPLATE/planned_feature.yml Show resolved Hide resolved

.github/ISSUE_TEMPLATE/question.yml Outdated Show resolved Hide resolved

mkh-user added 2 commits November 19, 2025 20:51

Fix question template parameters

0513f2f

Update config.yml

96195ed

mkh-user merged commit 1c069a1 into Main Nov 19, 2025
2 checks passed

github-project-automation bot moved this from In Progress to Completed in Release: Text Forge 1.0 Nov 19, 2025

mkh-user deleted the new-issue-templates branch November 19, 2025 17:29

mkh-user mentioned this pull request Nov 21, 2025

Update PR template and remove old templates #134

Merged

6 tasks

coderabbitai bot mentioned this pull request Dec 24, 2025

Update bug report issue template with new versions #172

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update and improve issue templates #129

Update and improve issue templates #129

Uh oh!

mkh-user commented Nov 19, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 19, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update and improve issue templates #129

Update and improve issue templates #129

Uh oh!

Conversation

mkh-user commented Nov 19, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Impact

Additional Information

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mkh-user commented Nov 19, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 19, 2025 •

edited

Loading