Skip to content

fix: bug-report issue template silently dropped by chooser (description over length limit) - #4100

Merged
YangXu1990uiuc merged 2 commits into
flashinfer-ai:mainfrom
YangXu1990uiuc:yanxu/fix-bug-template-desc
Jul 23, 2026
Merged

fix: bug-report issue template silently dropped by chooser (description over length limit)#4100
YangXu1990uiuc merged 2 commits into
flashinfer-ai:mainfrom
YangXu1990uiuc:yanxu/fix-bug-template-desc

Conversation

@YangXu1990uiuc

@YangXu1990uiuc YangXu1990uiuc commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

📌 Description

Follow-up to #4007: the 🐛 Bug Report template was silently missing from the issue template chooser (only 🚀 Kernel / Feature Request appeared), even though the file is valid YAML and passes the published issue-forms JSON schema.

Root cause: GitHub enforces an undocumented length limit on an issue form's top-level description and silently drops templates that exceed it. Ours was 218 characters; the feature template's was 180.

Evidence (bisected on a fork, one variable per variant):

description length renders in chooser
T7 (with and /) 137
feature template 180
bug template (byte-exact copy) 218
T6 (all non-ASCII punctuation removed) 241

Removing render: / placeholder: did not help; special characters and emoji are innocent (feature template has both). The limit sits in (180, 218] — presumably 200, matching the legacy markdown templates' about field.

Fix: tighten both templates' descriptions to a single sentence (bug: 61 chars, feature: 94) — the chooser shows the two templates side by side, so the cross-referencing routing sentences were redundant anyway. Verified rendering on a fork.

🔍 Related Issues

Follow-up to #4007.

🚀 Pull Request Checklist

✅ Pre-commit Checks

  • I have installed pre-commit by running pip install pre-commit (or used your preferred method).
  • I have installed the hooks with pre-commit install.
  • I have run the hooks manually with pre-commit run --all-files and fixed any reported issues.

🧪 Tests

  • Tests have been added or updated as needed.
  • All tests are passing (unittest, etc.).

(Template-only change; YAML validated, rendering verified on a fork with identical content.)

Reviewer Notes

Neither GitHub's issue-forms docs nor the SchemaStore JSON schema encode this limit — worth remembering when editing template descriptions.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the bug report template to use shorter, clearer guidance for reporting items that are broken, wrong, or slower than before (including correctness issues, crashes, and performance regressions).
    • Updated the feature request template description to use a single, streamlined prompt covering capability improvements and related requests.

The top-level description was 218 characters. GitHub enforces an
undocumented length limit on an issue form's top-level description
(somewhere in (180, 218]; the legacy .md 'about' limit of 200 is the
likely value) and templates exceeding it are silently omitted from the
template chooser — the form passes the published JSON schema and none of
the documented validation errors apply.

Root-caused by bisection on a fork: a byte-exact copy failed to render;
removing render:/placeholder: did not help; descriptions at 137 and 180
chars rendered, 218 and 241 did not, including a 241-char version with
all non-ASCII punctuation removed. Shortened to 156 characters.

AI-assisted (Claude Code).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The bug report and feature request issue template descriptions were shortened and rephrased without changing template routing or labels.

Changes

Issue template descriptions

Layer / File(s) Summary
Update issue template descriptions
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml
Replaces the multi-line prompts with shorter single-line descriptions for bug reports and feature requests.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: sricketts, dhiraj113, aleozlx, yongwww, yzh119

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main change: shortening issue template descriptions to fix the chooser omission.
Description check ✅ Passed The description follows the template and includes the summary, related issue, checklist, tests, and reviewer notes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

The chooser shows both templates side by side, so the cross-referencing
routing sentences were redundant — and overlong descriptions are exactly
what triggered the silent-drop bug being fixed here.

AI-assisted (Claude Code).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@YangXu1990uiuc
YangXu1990uiuc enabled auto-merge (squash) July 22, 2026 21:05
@aleozlx aleozlx added the run-ci label Jul 22, 2026
@YangXu1990uiuc
YangXu1990uiuc merged commit e4b8594 into flashinfer-ai:main Jul 23, 2026
50 of 55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants