feat: add new issue templates for bug reports, documentation improvem…#44
feat: add new issue templates for bug reports, documentation improvem…#44
Conversation
…ents, and feature requests
WalkthroughGitHub 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. Comment |
… improvements, and feature requests
There was a problem hiding this comment.
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 toptype: markdownblock (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 toptype: markdownblock pointing to the repo’s security reporting path avoids accidental disclosure..github/ISSUE_TEMPLATE/docs_improvement.yml (1)
7-14: Add aplaceholderexample forlocation.
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
📒 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: Theenhancementlabel exists in the repository and is properly configured. No action required.
…ents, and feature requests
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.