docs: add GitHub issue templates for bug reports and feature requests#45
Merged
gordonmurray merged 1 commit intolance-format:mainfrom Apr 7, 2026
Merged
Conversation
Adds two YAML issue forms under `.github/ISSUE_TEMPLATE/`: - `bug_report.yml` with a required dropdown for the container tag, plus required fields for host OS, reproduction steps, and error output. The container tag dropdown means triage no longer has to ask "which version are you running" as a first reply. - `feature_request.yml` with summary, use case, optional implementation sketch, and a required checkbox confirming the filer has read the design constraints in CONTRIBUTING.md. YAML issue forms enforce required fields at submit time, unlike Markdown templates where users can delete the placeholders. Fixes lance-format#44
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #44
Adds two YAML issue forms under
.github/ISSUE_TEMPLATE/:bug_report.ymlStructured bug report with required fields for:
Plus optional fields for Lance data source (what wrote the files) and logs/error output.
The container tag dropdown is the main DX win: triage no longer needs to ask "which version are you running" as a first reply, which is currently the most common first question on bug reports in this project.
feature_request.ymlStructured feature request with:
The constraint checkbox links to CONTRIBUTING.md (merged in #43) and lists the five load-bearing constraints inline in the description, so the filer sees them even without clicking through.
Notes
Both templates are YAML issue forms, not Markdown. The difference matters: YAML forms enforce required fields at submit time, whereas Markdown templates let users delete the placeholder and file an empty issue.
blank_issues_enabledis left at the default (true) so users can still file unstructured issues if neither template fits. If that turns out to be noisy in practice, aconfig.ymlcan be added later to disable blank issues.