ci: add issue templates for website bugs, enhancements and good first issues - #679
Conversation
… issues The repository had two templates, both for documentation content, and blank issues are disabled. Site bugs, enhancements and good first issues had no template to file under, so they were filed as documentation issues or arrived with no useful classification. Both existing templates also declared `labels: kind/documentation`, a label that did not exist in this repository. GitHub drops an unknown label silently, so the only issue automation present had never actually applied anything. The kind/* labels now exist, matching the names, colors and descriptions used in the HAMi repository. The new templates follow the same pattern already used in HAMi, where each template carries the label its issue type should have. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThree GitHub issue templates were added for enhancement requests, good-first issues, and website bug reports. Each template includes issue metadata and structured prompts tailored to its submission type. ChangesIssue template additions
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested labels: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
|
Let's align labels first though. The repo has overlapping schemes: your new kind/, plus area/ and priority/*, plus four issues still labeled flat enhancement (#658 #662 #666 #680). Proposal: standardize on kind/* (type), area/* (scope), priority/* (urgency). |
|
agreed, done:
|
|
config is ready in #687, kept it a separate pr since it changes bot behaviour for every contributor, and left |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mesutoezdil, rootsongjc The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
2 participants
Why
Two things were wrong with issue labeling here.
The existing automation never worked. Both current templates declare
labels: kind/documentation, but that label did not exist in this repository. GitHub drops an unknown label silently, with no warning on the issue or in the template. Sinceblank_issues_enabled: falseforces everyone through a template, every issue filed here should have arrived labeled, and none did. That is most of why 18 of 21 open issues had no label before the recent manual pass.Three issue types had no template. The repository only offered "Documentation issue" and "Documentation improvement", both about docs content. Site bugs (#659 wrong dates, #664 broken code blocks), enhancements (#658 SEO, #662 image sizing, #666 i18n) and good first issues had nowhere to go.
What changed
Labels created first, matching HAMi's names, colors and descriptions:
kind/documentation0075cakind/bugd73a4akind/featureC5DEF5Labels live in repository settings rather than in the tree, so they are not part of this diff.
Templates added:
good-first.mdgood first issuesite-bug.mdkind/bugenhancement.mdkind/featureEvery template in the directory now maps to a label that exists:
good-first.mdmirrors the one in HAMi, including the/assigninstruction and the note that good first issues are reserved for first-time contributors.Effect
New issues arrive labeled without anyone doing a manual pass. The
good first issuefilter, which is how newcomers find an entry point, fills itself as maintainers file tasks under that template.npm run format:checkpasses.Summary by CodeRabbit