Skip to content

chore: set issue type on GitHub issue templates - #9559

Open
sriramveeraghanta wants to merge 1 commit into
previewfrom
chore/github-issue-templates-issue-type
Open

chore: set issue type on GitHub issue templates#9559
sriramveeraghanta wants to merge 1 commit into
previewfrom
chore/github-issue-templates-issue-type

Conversation

@sriramveeraghanta

@sriramveeraghanta sriramveeraghanta commented Aug 6, 2026

Copy link
Copy Markdown
Member

Description

Wires the GitHub issue forms up to the org-level Issue Types and aligns them with the newly created Issue Fields.

  • Added type: Bug to the bug report form and type: Feature to the feature request form. Issues opened from these templates are now automatically tagged with the corresponding org issue type, so they land correctly in type-based filters and views without manual triage.
  • Renamed the bug form's Variant dropdown to Edition and changed its options from Cloud / Self-hosted / Local to Community / Commercial / Cloud, matching the Edition issue field exactly.
  • Added descriptions to Edition and Version mirroring their issue-field descriptions.

Note on Issue Fields: GitHub issue form YAML has no key or input type for setting issue field values — fields are org-level config, pinned to an issue type, and rendered in the issue sidebar outside the form. The template can't populate them. The form inputs are kept so reporters still supply Edition/Version as part of the submission; a maintainer with triage access copies the values into the sidebar fields. (GitHub doesn't document whether non-collaborators can set sidebar field values at creation, so dropping the inputs risked losing that data on community-filed bugs.)

The type: values are matched by exact string against the enabled org issue types (Task, Bug, Feature, Documentation) — renaming a type in org settings will silently stop the template from applying it.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

  • Open New issue → Bug report on this branch and submit; confirm the created issue shows type Bug in the sidebar and still carries the 🐛bug / plane labels.
  • Open New issue → Feature request and submit; confirm the created issue shows type Feature.
  • On the bug form, confirm the Edition dropdown offers Community / Commercial / Cloud and is required, and that Version shows its new description.
  • Confirm the Edition and Version issue fields render in the sidebar of a Bug-typed issue (requires them to be pinned to the Bug type in org settings).
  • Both YAML files parse cleanly and only use documented top-level keys.

References

Follow-ups not included here: the Documentation issue type has no matching template yet, and the 🐛bug / ✨feature labels are now redundant with issue types.

https://claude.ai/code/session_017DPVwh1J21mZYRHjpTL7zg

Summary by CodeRabbit

  • Documentation
    • Improved the bug report form with clearer product edition options and updated version-reporting guidance.
    • Explicitly categorized bug reports and feature requests in issue forms for more consistent submissions.

Add the `type:` key to the bug report and feature request issue forms so
issues opened from them are automatically tagged with the org-level
`Bug` and `Feature` issue types.

Also align the bug form with the new org issue fields: rename the
`Variant` dropdown to `Edition` (Community/Commercial/Cloud) and add
descriptions matching the `Edition` and `Version` issue fields, so
triage can copy the values straight into the sidebar.

Claude-Session: https://claude.ai/code/session_017DPVwh1J21mZYRHjpTL7zg
Copilot AI lite review requested due to automatic review settings August 6, 2026 10:41
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 99ac7fdf-3482-4eda-bc64-831a7050dd9b

📥 Commits

Reviewing files that changed from the base of the PR and between 31853ab and 7470478.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/--bug-report.yaml
  • .github/ISSUE_TEMPLATE/--feature-request.yaml

📝 Walkthrough

Walkthrough

The issue forms now declare explicit GitHub types. The bug report collects edition information using Community, Commercial, and Cloud options and updates its version prompt for Cloud users.

Changes

Issue template updates

Layer / File(s) Summary
Form metadata and bug report fields
.github/ISSUE_TEMPLATE/--bug-report.yaml, .github/ISSUE_TEMPLATE/--feature-request.yaml
The forms declare Bug and Feature types. The bug report replaces the variant field with a required edition field and updates the version description.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: assigning issue types to GitHub issue templates.
Description check ✅ Passed The description covers the changes, change type, test scenarios, and references with sufficient implementation context.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/github-issue-templates-issue-type

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the repository’s GitHub Issue Forms to align newly submitted issues with org-level Issue Types and to keep form inputs consistent with the org’s Issue Fields (notably renaming “Variant” → “Edition” and matching option values).

Changes:

  • Added top-level type: Feature / type: Bug to the Feature Request and Bug Report issue forms.
  • Renamed the bug form dropdown from Variant to Edition, and updated options to Community / Commercial / Cloud.
  • Added descriptive helper text for the Edition and Version inputs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
.github/ISSUE_TEMPLATE/--feature-request.yaml Adds type: Feature so issues created from the template map to the org “Feature” issue type.
.github/ISSUE_TEMPLATE/--bug-report.yaml Adds type: Bug, renames VariantEdition, updates dropdown options, and adds descriptions for Edition/Version.

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.

2 participants