Skip to content

Commit 076a864

Browse files
TheGreatAxiosTheGreatAxios
committed
feat(github): add bug report and feature request issue templates
.github had a pull-request template and nothing for issues, so a new issue opened as an empty box and arrived without the version, platform, provider, or model needed to start on it. The bug report is an issue form, so version, platform, install method, reproduction, and whether it reproduces on a clean config are required rather than suggested. Provider and model are required too, answerable with "not inference" — the field only costs something when it matters. The feature request stays markdown: a form there is friction on someone doing us a favour. Blank issues stay enabled. Discussions is not turned on for this repository, so disabling them would leave anyone with a question pushed into the wrong template. Templates link to CONTRIBUTING.md rather than restating it, and route security reports to private disclosure. CL-7890
1 parent edb517f commit 076a864

3 files changed

Lines changed: 130 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Bug report
2+
description: Something in Corbits Code does not work the way it should
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before filing, please search existing issues — including closed ones.
9+
10+
Never paste API keys, tokens, or the contents of `~/.corbits/settings.json`.
11+
Redact anything that looks like a credential before you submit.
12+
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: What happened
17+
description: What you did, and what Corbits Code did instead.
18+
placeholder: |
19+
I ran `corbits exec "..."` and the session stopped after the first tool call.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: expected
25+
attributes:
26+
label: What you expected instead
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: reproduce
32+
attributes:
33+
label: Steps to reproduce
34+
description: The shortest sequence that shows the problem. A fixture repo or a minimal project beats a description.
35+
placeholder: |
36+
1. ...
37+
2. ...
38+
3. ...
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: version
44+
attributes:
45+
label: Version
46+
description: Output of `corbits --version`.
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: platform
52+
attributes:
53+
label: OS and architecture
54+
placeholder: macOS 15.2 arm64
55+
validations:
56+
required: true
57+
58+
- type: input
59+
id: install-method
60+
attributes:
61+
label: How you installed it
62+
placeholder: Homebrew, or built from source at <commit>
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: provider-model
68+
attributes:
69+
label: Provider and model
70+
description: Required when the bug involves inference — a wrong answer, a hang, a protocol error, token or cost accounting. Write "not inference" if it does not.
71+
placeholder: opencode-go, muse-spark-1.3-contributor
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: output
77+
attributes:
78+
label: Relevant output
79+
description: The error and the lines around it — not a whole session transcript. This is rendered as a code block, so no backticks needed.
80+
render: text
81+
82+
- type: dropdown
83+
id: clean-config
84+
attributes:
85+
label: Does it reproduce on a clean config?
86+
description: A fresh profile, without your plugins, skills, MCP servers, or hooks. This is the single most useful thing you can tell us.
87+
options:
88+
- "Yes — reproduces on a clean config"
89+
- "No — only with my config"
90+
- "Not tried"
91+
validations:
92+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Blank issues stay enabled deliberately: GitHub Discussions is not turned on for
2+
# this repository, so disabling them would leave anyone with a question — rather
3+
# than a bug or a feature request — with nowhere to go but the wrong template.
4+
# Turn this off if Discussions is ever enabled.
5+
blank_issues_enabled: true
6+
contact_links:
7+
- name: Security vulnerability
8+
url: https://github.com/corbitsdev/corbits-code/security/advisories/new
9+
about: Do not report security issues publicly. Use private vulnerability reporting.
10+
- name: Documentation
11+
url: https://github.com/corbitsdev/corbits-code/tree/main/docs
12+
about: Architecture, implementation, TUI behavior, plugins, MCP, hooks, and telemetry.
13+
- name: Contributing
14+
url: https://github.com/corbitsdev/corbits-code/blob/main/CONTRIBUTING.md
15+
about: Commit, pull request, and issue-linking conventions. Read before opening a pull request.

‎.github/ISSUE_TEMPLATE/feature-request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest a capability Corbits Code does not have
4+
labels: ["feature"]
5+
---
6+
7+
## The problem
8+
9+
What are you trying to do, and what stops you? Describe the problem before the
10+
solution — the best fix is often not the one either of us thought of first.
11+
12+
## What you do today instead
13+
14+
The workaround, however ugly. This tells us how much the problem costs you.
15+
16+
## What you have already ruled out
17+
18+
Approaches you considered and rejected, and why. Saves us proposing them back
19+
to you.
20+
21+
## Anything else
22+
23+
Prior art in other tools, links, sketches.

0 commit comments

Comments
 (0)