Skip to content

docs(github): add a bug report issue form (#502) - #982

Draft
asdf80730 wants to merge 2 commits into
EasyIME:masterfrom
asdf80730:docs/502-issue-template
Draft

asdf80730 wants to merge 2 commits into
EasyIME:masterfrom
asdf80730:docs/502-issue-template

Conversation

@asdf80730

Copy link
Copy Markdown
Contributor

Summary

Adds one issue form at .github/ISSUE_TEMPLATE/bug_report.yml. Every future problem report arrives with the data triage already asks for, so a report can become a patch instead of a retest round-trip.

 .github/
+├── ISSUE_TEMPLATE/
+│   └── bug_report.yml   # version, Windows build, input method, app, steps, logs
 ├── copilot-instructions.md
 └── workflows/

The fields are the ones #502 proposed, plus the two log locations the repo already has:

#502 asked for Form field
describe the bug problem (required)
screenshot noted in the intro; screenshots go in any text field
expected result expected (required)
environment: Windows build, PIME version windows-version, pime-version (required)
steps to reproduce steps (required)
other useful data logs (optional)

Two additions beyond the issue: the input method and the application, because the backend and TSF layers differ per module and per host (python_backend.log only covers the Python backend). The form sets labels: ["bug"], matching the label PCMan had to add by hand across the old backlog on 10-17.

One template only, no config.yml chooser — the blank-issue path stays available for feature requests.

Evidence

  • Before: git ls-tree -r --name-only origin/master .github/ lists only copilot-instructions.md and the two workflows; search/issues?q=repo:EasyIME/PIME+is:pr+ISSUE_TEMPLATE returns 0, so nothing competes with this.
  • After: bun -e 'Bun.YAML.parse(await Bun.file(".github/ISSUE_TEMPLATE/bug_report.yml").text())' parses, and the file validates against the SchemaStore github-issue-forms.json schema with ajv-cli (valid, 10 body items, description 65 chars).
  • GitHub renders issue forms from the default branch, so the form itself can only be seen after merge; the schema check is the offline equivalent. Field paths are taken from the tree: %LOCALAPPDATA%\PIME\Logs\python_backend.log (python/server.py:34-36), /console and /log-file (PIMELauncher/src/main.rs:161-162), version.txt (installer/installer.nsi:294).

Merge Danger

Door: two-way — one YAML file; deleting it restores the blank issue form.

Blast Radius: issue creation UX

Generated with assistance from DeepSeek V4.1 Flash.

Reports arrive without the Windows build, the PIME version, the input method
or reproduction steps, so each one costs a retest round-trip before a fix can
start. Add one issue form that asks for the fields EasyIME#502 lists, plus where to
find the backend and launcher logs, and files the result under `bug`.

Generated with assistance from DeepSeek V4.1 Flash.
The form shipped a 2.0.0-beta3 placeholder while upstream already tags
2.0.0-beta4, so the example nudged reporters toward a stale build.

Generated with assistance from omp (deepseek-v4.1-flash)

This branch has not been deployed

No deployments
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