Skip to content

chore: add issue templates#368

Merged
benvinegar merged 2 commits into
mainfrom
chore/add-issue-templates
May 25, 2026
Merged

chore: add issue templates#368
benvinegar merged 2 commits into
mainfrom
chore/add-issue-templates

Conversation

@benvinegar

Copy link
Copy Markdown
Member

Summary

  • Add concise bug report and contribution proposal issue forms
  • Disable blank issues and route questions/discussion to Discord
  • Ask contributors to read CONTRIBUTING.md without adding strict new-contributor warnings

Validation

  • Not run; GitHub issue template YAML only
  • Pre-commit hook ran oxfmt --write on the staged YAML files

This PR description was generated by Pi using GPT-5

@greptile-apps

greptile-apps Bot commented May 25, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds three GitHub issue template files to standardize how bugs and contribution proposals are submitted, while disabling blank issues and redirecting questions to Discord.

  • bug.yml defines a concise bug report form requiring a description and reproduction steps, with optional expected behavior and version fields, and auto-applies the \"bug\" label.
  • contribution.yml defines a proposal form requiring what/why fields (and an optional how), but leaves labels: [] so submitted issues receive no automatic label — making them harder to filter from the issue list.
  • config.yml disables blank issues and adds a Discord contact link for questions and discussion.

Confidence Score: 4/5

Safe to merge; the only change is adding GitHub issue template YAML files with no runtime impact.

The contribution proposal template leaves labels: [], so all submitted contribution proposals arrive unlabeled and cannot be easily filtered or triaged without manual label assignment.

contribution.yml — the empty labels array is the one item worth reconsidering before merge.

Important Files Changed

Filename Overview
.github/ISSUE_TEMPLATE/bug.yml Well-structured bug report form with required description and reproduction steps, optional expected behavior and version fields; CONTRIBUTING.md reference is correct.
.github/ISSUE_TEMPLATE/config.yml Disables blank issues and routes questions to Discord; format is correct for GitHub issue template config.
.github/ISSUE_TEMPLATE/contribution.yml Contribution proposal form with required what/why fields and optional how; labels: [] leaves issues unlabeled, making triage harder compared to the bug template which correctly assigns a label.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens new issue] --> B{Select template}
    B --> C[Bug Report\nbug.yml]
    B --> D[Contribution Proposal\ncontribution.yml]
    B --> E[Questions / Discussion\nconfig.yml contact_link]
    C --> F[Requires: description + repro steps\nOptional: expected behavior + version\nAuto-label: bug]
    D --> G[Requires: what + why\nOptional: how\nAuto-label: none]
    E --> H[Redirected to Discord\nhttps://discord.gg/WZFjaP6Gt8]
    B --> I{blank_issues_enabled: false}
    I --> J[Blank issues disabled]
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
.github/ISSUE_TEMPLATE/contribution.yml:3
Empty labels array means contribution proposals won't be automatically tagged when submitted. Unlike `bug.yml` which applies the `"bug"` label, these issues will have no label, making them harder to filter and triage in the issue tracker.

```suggestion
labels: ["proposal"]
```

Reviews (1): Last reviewed commit: "chore: add issue templates" | Re-trigger Greptile

Comment thread .github/ISSUE_TEMPLATE/contribution.yml Outdated
@@ -0,0 +1,34 @@
name: Contribution Proposal
description: Propose a change or feature before opening a larger PR
labels: []

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.

P2 Empty labels array means contribution proposals won't be automatically tagged when submitted. Unlike bug.yml which applies the "bug" label, these issues will have no label, making them harder to filter and triage in the issue tracker.

Suggested change
labels: []
labels: ["proposal"]
Prompt To Fix With AI
This is a comment left during a code review.
Path: .github/ISSUE_TEMPLATE/contribution.yml
Line: 3

Comment:
Empty labels array means contribution proposals won't be automatically tagged when submitted. Unlike `bug.yml` which applies the `"bug"` label, these issues will have no label, making them harder to filter and triage in the issue tracker.

```suggestion
labels: ["proposal"]
```

How can I resolve this? If you propose a fix, please make it concise.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good call. I added the existing enhancement label so contribution proposal issues are automatically tagged for triage. I used enhancement instead of proposal because the repo does not currently have a proposal label.

Responded by Pi using GPT-5.

@benvinegar benvinegar merged commit 65b971d into main May 25, 2026
5 checks passed
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.

1 participant