Skip to content

Update issue templates - #231

Open
brent-hoover wants to merge 1 commit into
developfrom
issue-templates
Open

Update issue templates#231
brent-hoover wants to merge 1 commit into
developfrom
issue-templates

Conversation

@brent-hoover

Copy link
Copy Markdown
Owner

No description provided.

@claude

claude Bot commented Jun 28, 2026

Copy link
Copy Markdown

Claude finished @brent-hoover's task in 34s —— View job


PR Review: Update issue templates

Tasks

  • Read changed files
  • Analyze templates against project context

Overall Assessment

These are GitHub's default issue template boilerplates added verbatim. The feature request template is largely fine, but the bug report template has several sections that are mismatched for a Python CLI/TUI tool — not a web or mobile app.


bug_report.md — Issues

Desktop "Browser" field and entire Smartphone section are irrelevant.

jig is a CLI/TUI orchestrator. Users do not interact with it via a browser or smartphone. These sections should be removed and replaced with fields relevant to how jig actually runs.

Suggested replacement for the environment section:

**Environment:**
 - OS: [e.g. Ubuntu 22.04, macOS 14]
 - Python version: [e.g. 3.12.3]
 - jig version / git SHA: [e.g. v0.4.1 or abc1234]
 - Run mode: [Docker / --no-docker / bwrap]

Steps to reproduce use GUI language.

Line 14: 2. Click on '....'jig has no clickable UI. The placeholder copy should be CLI-oriented:

1. Run `jig ...`
2. Observe output / error

No field for logs or error output.

Bug reports for an async orchestrator almost always need the terminal output or .jig/ log content. A dedicated section would reduce back-and-forth:

**Relevant log output**
Paste the relevant terminal output or contents of `.jig/store/` here.

feature_request.md — Minor

The template is generic but workable. One optional improvement: align the framing with jig's documented problem-statement-first workflow (CLAUDE.md):

Non-trivial work follows: problem statement → design → plan → code.

A prompt like "Describe the problem this feature would solve" fits that model better than "Is your feature request related to a problem?", but this is a nit.


Summary

File Status
bug_report.md Needs revision — remove browser/smartphone sections, add jig-specific env fields and log output section
feature_request.md Acceptable as-is

The bug report template as currently written would prompt contributors to fill in irrelevant fields (browser, device) and omit the information (run mode, logs) that would actually help debug jig issues.

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