Skip to content

Add issue templates#514

Merged
rob93c merged 2 commits into
mainfrom
add-issue-templates
Jun 15, 2026
Merged

Add issue templates#514
rob93c merged 2 commits into
mainfrom
add-issue-templates

Conversation

@rob93c

@rob93c rob93c commented Jun 15, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Chores
    • Added standardised GitHub issue templates for bug reports, feature requests, and file format support requests to streamline issue submissions and gather consistent information.

@coderabbitai

coderabbitai Bot commented Jun 15, 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 067fdfe2-57d2-4230-9c6d-84c21e002e54

📥 Commits

Reviewing files that changed from the base of the PR and between 54a0b53 and f66cfc9.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/bug-report.md
  • .github/ISSUE_TEMPLATE/feature-request.md
  • .github/ISSUE_TEMPLATE/support-new-file-format.md
✅ Files skipped from review due to trivial changes (3)
  • .github/ISSUE_TEMPLATE/feature-request.md
  • .github/ISSUE_TEMPLATE/bug-report.md
  • .github/ISSUE_TEMPLATE/support-new-file-format.md

📝 Walkthrough

Walkthrough

Three new GitHub issue templates are added under .github/ISSUE_TEMPLATE/: one for bug reports (with fields for description, reproduction steps, expected behaviour, files, and screenshots), one for feature requests (problem, solution, and context), and one for new file format support requests (format name, optional sample, and context).

Changes

GitHub Issue Templates

Layer / File(s) Summary
Issue templates with metadata and form bodies
.github/ISSUE_TEMPLATE/bug-report.md, .github/ISSUE_TEMPLATE/feature-request.md, .github/ISSUE_TEMPLATE/support-new-file-format.md
Adds three GitHub issue templates, each with YAML front-matter metadata (name, about/description, title, labels, assignees, type) and structured body sections guiding reporters through relevant fields.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Three little templates, fresh and neat,
A bug, a wish, a format feat.
🐇 The rabbit hops and stamps each form,
No more blank issues to cause a storm!
Labels and types, all set just right — 🏷️
Filing issues is a pure delight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add issue templates' directly and clearly summarises the main change—three new GitHub issue templates were added to the .github/ISSUE_TEMPLATE directory.
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.

✏️ 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.

@rob93c rob93c self-assigned this Jun 15, 2026
@rob93c rob93c added the documentation Improvements or additions to documentation label Jun 15, 2026

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/feature_request.md (1)

1-7: ⚡ Quick win

Consider adding a default label for feature requests.

The bug-report.md and support-a-new-file-format.md templates both define default labels (bug and enhancement respectively), but this feature-request template leaves the labels field empty. Adding a default label like feature would help with issue triage and categorisation, making it easier to discover feature requests.

Consider adding labels: feature to the frontmatter metadata.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/ISSUE_TEMPLATE/feature_request.md around lines 1 - 7, The
feature_request.md template has an empty labels field while other similar issue
templates like bug-report.md define default labels for triage and
categorization. Update the labels field in the frontmatter metadata from an
empty string to a default label value such as "feature" to maintain consistency
with other templates and improve issue discoverability and categorization.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/feature_request.md:
- Around line 1-7: Rename the file from feature_request.md to feature-request.md
to align with the hyphen-based naming convention used by other issue templates
in the repository such as bug-report.md and support-a-new-file-format.md. This
maintains consistency with GitHub issue template conventions and the patterns
already established in this PR.

---

Nitpick comments:
In @.github/ISSUE_TEMPLATE/feature_request.md:
- Around line 1-7: The feature_request.md template has an empty labels field
while other similar issue templates like bug-report.md define default labels for
triage and categorization. Update the labels field in the frontmatter metadata
from an empty string to a default label value such as "feature" to maintain
consistency with other templates and improve issue discoverability and
categorization.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ff217b17-3e41-43b5-9883-dc389e823c74

📥 Commits

Reviewing files that changed from the base of the PR and between 7358c34 and 80c5bd4.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/bug-report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/support-a-new-file-format.md

Comment thread .github/ISSUE_TEMPLATE/feature-request.md
@rob93c rob93c force-pushed the add-issue-templates branch from 54a0b53 to f66cfc9 Compare June 15, 2026 20:02
@rob93c

rob93c commented Jun 15, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@rob93c rob93c merged commit e519a39 into main Jun 15, 2026
11 of 12 checks passed
@rob93c rob93c deleted the add-issue-templates branch June 15, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant