Skip to content

Commit 46740c1

Browse files
mjacobsmjacobs
authored
docs: add GitHub issue forms for bug reports, agent support, and feature requests (#713)
Adds `.github/ISSUE_TEMPLATE/` with three issue forms and a config. The repo currently has no templates, so reports often arrive missing the context a maintainer needs to act on them. The fields are derived from what recurring issues actually lacked: - **Version** is the single most-chased detail (for example #575 opens with "which version were you on?"). The bug form requires `agentsview version` output up front, alongside install method and OS. - **Parse / render / usage bugs** are only actionable with the underlying session data. The reports that got fixed quickly carried a sample file or the raw entry (#504, #515, #639, #646); the recent #703 ("no tool call message render") is a plausible bug that stalled for lack of one. The bug form asks for a sanitized sample session file or snippet, with a checkbox reminding filers to strip secrets. - **New-agent requests** live or die on where the sessions live and what they look like. The useful ones named the storage path (#685); the thin ones drew "ask the agent to make a PR so it can look at real data" (#617). The agent form requires the storage path and asks for a real sample file. `config.yml` sets `blank_issues_enabled: false` so every new issue routes through a form. The Discussions contact link is intentionally omitted because Discussions is not enabled on this repo; a comment notes how to add it if that changes. Where to look: the three `.yml` field sets. No application code is touched. Co-authored-by: Matthew Jacobs <mjacobs@users.noreply.github.com>
1 parent 1fc423a commit 46740c1

4 files changed

Lines changed: 169 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/agent_support.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: New agent support
2+
description: Request support for a coding agent agentsview does not parse yet
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please search existing issues first; support for many agents is already
9+
requested or in progress.
10+
11+
A real (redacted) session file is by far the most useful thing you can
12+
provide. It lets a parser be written against actual data instead of a
13+
guessed file format.
14+
- type: input
15+
id: agent-name
16+
attributes:
17+
label: Agent name and link
18+
placeholder: "Kimi Code - https://github.com/MoonshotAI/kimi-code"
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: storage
23+
attributes:
24+
label: Where does it store sessions?
25+
description: Directory path(s), per OS if they differ
26+
placeholder: "~/.kimi-code/sessions/"
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: format
31+
attributes:
32+
label: File format
33+
description: One file per session or many? JSON / JSONL / nested directories? Anything notable about the layout.
34+
- type: textarea
35+
id: sample
36+
attributes:
37+
label: Sample session file
38+
description: >
39+
Attach a real session file with secrets and private data removed. This
40+
is the most valuable part of the request.
41+
render: text
42+
- type: checkboxes
43+
id: help
44+
attributes:
45+
label: Can you help?
46+
options:
47+
- label: I can share a sample session file
48+
- label: I use this agent and can test a PR or build a parser

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Bug report
2+
description: Something is parsed, rendered, counted, installed, or updated incorrectly
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for filing a bug. Please search existing issues first.
9+
10+
For a wrong-render, wrong-count, or wrong-parse bug, the single most
11+
useful thing you can give us is a small session file that reproduces it.
12+
Session files can contain secrets and proprietary code, so redact before
13+
sharing.
14+
- type: input
15+
id: version
16+
attributes:
17+
label: agentsview version
18+
description: "Output of `agentsview version`"
19+
placeholder: "agentsview v0.32.1 (commit 1964e4f8, built 2026-06-05T19:05:47Z)"
20+
validations:
21+
required: true
22+
- type: dropdown
23+
id: install
24+
attributes:
25+
label: Install method
26+
options:
27+
- Homebrew cask
28+
- install.sh / install.ps1
29+
- GitHub release binary
30+
- Docker image
31+
- go install
32+
- Built from source
33+
- Other / not sure
34+
validations:
35+
required: true
36+
- type: input
37+
id: os
38+
attributes:
39+
label: OS / platform
40+
placeholder: "macOS 26.5 (arm64) / Windows 11 / Fedora 44"
41+
validations:
42+
required: true
43+
- type: input
44+
id: agent
45+
attributes:
46+
label: Which agent and version
47+
description: The coding agent whose sessions are affected, plus its version. Write "n/a" for bugs unrelated to a specific agent (install, updater, UI).
48+
placeholder: "OpenClaw 0.x.y"
49+
validations:
50+
required: true
51+
- type: input
52+
id: model
53+
attributes:
54+
label: Which model(s)
55+
description: The model(s) behind the affected session, with provider if relevant. Write "n/a" if not applicable.
56+
placeholder: "claude-opus-4-8 / gpt-5 / gemini-3-pro"
57+
validations:
58+
required: true
59+
- type: textarea
60+
id: what-happened
61+
attributes:
62+
label: What happened, and what did you expect
63+
placeholder: "Tool-call messages do not render; only user/assistant turns show. Expected the tool call and its result to appear."
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: session-file
68+
attributes:
69+
label: Sample session file or snippet
70+
description: >
71+
For parse/render/usage bugs: attach a small session file that reproduces
72+
the problem, or paste the relevant entry (for example the raw tool-call
73+
object). Remove secrets and private data first.
74+
render: text
75+
- type: textarea
76+
id: repro
77+
attributes:
78+
label: Steps to reproduce
79+
placeholder: |
80+
1. ...
81+
2. ...
82+
Include exact CLI commands where relevant.
83+
- type: checkboxes
84+
id: hygiene
85+
attributes:
86+
label: Checklist
87+
options:
88+
- label: I searched existing issues
89+
required: true
90+
- label: I removed secrets and private data from any attached session files
91+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Route every new issue through one of the templates above. If GitHub
2+
# Discussions is enabled for this repo, add a contact_links entry pointing
3+
# usage/"how do I" questions there instead of the issue tracker.
4+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Feature request
2+
description: Suggest a new feature or an improvement to an existing one
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please search existing issues first. To request support for a new coding
9+
agent, use the "New agent support" template instead.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem / motivation
14+
description: What are you trying to do, and what makes it hard today?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Proposed solution
21+
description: What would you like agentsview to do?
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Alternatives considered
26+
description: Other approaches or workarounds you have tried or thought about.

0 commit comments

Comments
 (0)