Skip to content

feat: add new issue templates for bug reports, documentation improvem…#44

Merged
zeedivx merged 2 commits intomainfrom
chore/docs
Jan 10, 2026
Merged

feat: add new issue templates for bug reports, documentation improvem…#44
zeedivx merged 2 commits intomainfrom
chore/docs

Conversation

@zeedivx
Copy link
Contributor

@zeedivx zeedivx commented Jan 10, 2026

…ents, and feature requests

Summary by CodeRabbit

  • Chores
    • Modernized issue templates with structured form fields and validation. Users now experience a clearer, more consistent process when reporting bugs, requesting features, and suggesting documentation improvements, with better-organized fields for more complete submissions.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 10, 2026

Walkthrough

GitHub issue templates are being migrated from markdown format to YAML form format. Three templates—bug report, documentation improvement, and feature request—are being replaced with structured YAML versions that provide enhanced field validation and organization.

Changes

Cohort / File(s) Summary
Bug Report Template
bug_report.md, bug_report.yml
Replaced markdown template with YAML form template featuring structured fields for description, reproduction steps, expected behavior, screenshots, environment details, and context. Adds "[BUG]" title prefix and "bug" label automation.
Documentation Improvement Template
docs_improvement.md, docs_improvement.yml
Replaced markdown template with YAML form template adding fields for documentation location (input), problem identification, suggested improvements, and optional context. Sets "[DOCS]" title prefix and "documentation" label.
Feature Request Template
feature_request.md, feature_request.yml
Replaced markdown template with YAML form template introducing fields for problem description, desired solution, alternative considerations, and context. Applies "enhancement" label automatically.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hopping through templates with glee,
From markdown to YAML, you see,
Forms now structured, fields gleam bright,
Bug reports, docs, features—all right!
Configuration hops feel so light!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: converting old markdown issue templates to new YAML-based templates for bug reports, documentation improvements, and feature requests.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

Copy link
Contributor

@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 (4)
.github/ISSUE_TEMPLATE/feature_request.yml (1)

6-37: Consider adding an upfront “search existing issues” + “security issues go elsewhere” prompt.
A top type: markdown block (and/or required checkbox) reduces duplicates and routes vulns correctly.

.github/ISSUE_TEMPLATE/bug_report.yml (2)

6-62: Add a dedicated “Authly version / commit SHA” field (and keep browser info separate).
Right now “Version” in the Environment block reads like browser/app version and can be ambiguous.


1-5: Add a “Do not file security vulnerabilities here” notice.
A top type: markdown block pointing to the repo’s security reporting path avoids accidental disclosure.

.github/ISSUE_TEMPLATE/docs_improvement.yml (1)

7-14: Add a placeholder example for location.
Helps reporters paste a URL/anchor consistently (e.g., https://.../README.md#section).

📜 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 d3ded92 and ba76f73.

📒 Files selected for processing (6)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/docs_improvement.md
  • .github/ISSUE_TEMPLATE/docs_improvement.yml
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/feature_request.yml
💤 Files with no reviewable changes (3)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/docs_improvement.md
  • .github/ISSUE_TEMPLATE/feature_request.md
🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/docs_improvement.yml (1)

1-5: Verify the default label exists (documentation).
Same label-application concern as the other templates.

.github/ISSUE_TEMPLATE/feature_request.yml (1)

1-5: The enhancement label exists in the repository and is properly configured. No action required.

@zeedivx zeedivx merged commit b442def into main Jan 10, 2026
3 checks passed
@zeedivx zeedivx deleted the chore/docs branch January 10, 2026 21:24
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.

1 participant