Skip to content

docs: Community & Support section + issue templates#16

Merged
Dan8Oren merged 1 commit into
mainfrom
docs/community-support
Jun 5, 2026
Merged

docs: Community & Support section + issue templates#16
Dan8Oren merged 1 commit into
mainfrom
docs/community-support

Conversation

@Dan8Oren

@Dan8Oren Dan8Oren commented Jun 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a Community & Support section to the README pointing visitors at the right channel for bugs, ideas, questions, and showcases (Issues + each Discussions category).
  • Scaffolds GitHub Issue Form templates:
    • bug_report.yml — structured fields for macOS version, Node/Bun version, MCP client, config, and logs (the info that's most often missing today).
    • feature_request.yml — problem, proposal, alternatives, context.
    • config.yml — disables blank issues and redirects open-ended Q&A / ideas to Discussions so the issue tracker stays focused on actionable work.

Why

Issues and Discussions were both enabled but the README never pointed at them, and the issue tracker had no templates — so a stargazer who hit a problem had no obvious next step. This change makes contribution paths discoverable and raises the floor on report quality.

Test plan

  • README renders correctly on github.com (links to each Discussions category resolve)
  • "New issue" page on GitHub shows the bug + feature templates and the Q&A/Ideas/Show-and-tell contact links
  • Blank issue option is no longer available

Stargazers and new users had no obvious place to file bugs, ask
questions, or share ideas. This change closes that gap:

- README "Community & Support" section pointing people at Issues,
  Discussions (Ideas, Q&A, Show and tell, Announcements), and PRs.
- Structured Issue Form templates for bug reports and feature
  requests, asking for the info that's most often missing
  (macOS version, runtime, MCP client, config, logs).
- Issue chooser config redirects open-ended Q&A and ideas to
  Discussions instead of cluttering the issue tracker, and disables
  blank issues so every report has at least minimal structure.
@Dan8Oren Dan8Oren merged commit 6eae9ad into main Jun 5, 2026
1 check passed
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