Skip to content

Add GitHub issue templates and a PR template that capture environment + doctor --bundle #391

Description

@hojinzs

Problem

The repo has no .github/ISSUE_TEMPLATE/ and no PULL_REQUEST_TEMPLATE.md (find .github -type f returns only workflows/ci.yml and workflows/release.yml). Yet the README markets gh-symphony doctor --bundle as the bug-report mechanism (README.md:337, 368-380), and the project already has conventions in PROJECT_MANAGE.md:33-47 (Background / Proposed Changes / Affected Files) and PR expectations in CONTRIBUTING.md — none wired into GitHub-native templates. README does not even link to those docs, so a human filing via the GitHub UI gets a blank box.

Impact (OSS user)

With zero open issues, a new user hitting an onboarding failure has no structured way to report it, and maintainers receive low-context reports without OS/Node/install-method/runtime or the recommended support bundle. PRs arrive without the documented checklist.

Evidence (real files)

  • .github/ contains only workflows/.
  • README.md:337, 368-380 (doctor --bundle); packages/cli/src/support/bundle.ts builds it; packages/cli/src/commands/doctor.ts handles --bundle/--json.
  • PROJECT_MANAGE.md:33-47; CONTRIBUTING.md:18-23.

Proposed fix

Add .github/ISSUE_TEMPLATE/bug_report.yml (ask for OS, Node version, install method npm/docker, chosen runtime, gh-symphony doctor --json output, and an attached gh-symphony doctor --bundle) and feature_request.yml mirroring PROJECT_MANAGE.md's sections, plus .github/PULL_REQUEST_TEMPLATE.md mirroring CONTRIBUTING.md's checklist. Optionally a config.yml linking Discussions/CONTRIBUTING.


Priority: P1 · Symphony layer: DX/Meta · category: community-health
Filed from an OSS-user-perspective audit of the repo.

Metadata

Metadata

Assignees

Labels

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions