Browse Source

docs: streamline issue triage and support routing

Alvin Unreal 3 months ago
parent
commit
19f5bcade4

+ 73 - 0
.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,73 @@
+name: Bug report
+description: Report a reproducible bug in oh-my-opencode-slim.
+title: '[Bug]: '
+labels:
+  - bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for filing a bug. Keep it short, but include enough detail for us to reproduce it.
+  - type: textarea
+    id: happened
+    attributes:
+      label: What happened?
+      description: Describe the bug clearly.
+      placeholder: The plugin crashes when I run...
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+      placeholder: It should...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Share the smallest repro you can.
+      placeholder: |
+        1. Run...
+        2. Open...
+        3. See...
+    validations:
+      required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Relevant config
+      description: Paste the relevant part of your OpenCode or plugin config. Remove secrets first.
+      render: jsonc
+    validations:
+      required: true
+  - type: input
+    id: opencode-version
+    attributes:
+      label: OpenCode version
+      placeholder: 0.4.12
+    validations:
+      required: true
+  - type: input
+    id: plugin-version
+    attributes:
+      label: oh-my-opencode-slim version
+      placeholder: 0.0.0
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: macOS 15.4 / Ubuntu 24.04 / Windows 11
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs, screenshots, or extra context
+      description: Add anything else that may help us reproduce or understand the bug.
+      render: shell
+    validations:
+      required: false

+ 5 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions and support
+    url: https://t.me/boringdystopiadevelopment
+    about: Use Telegram for setup questions, troubleshooting help, and general support.

+ 27 - 0
.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,27 @@
+name: Feature request
+description: Suggest an improvement for oh-my-opencode-slim.
+title: '[Feature]: '
+labels:
+  - enhancement
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem are you trying to solve?
+      placeholder: I'm trying to...
+    validations:
+      required: true
+  - type: textarea
+    id: idea
+    attributes:
+      label: What do you want to happen?
+      placeholder: I want...
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Extra context
+      description: Optional examples, alternatives, or related links.
+    validations:
+      required: false

+ 1 - 10
.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1 @@
-## Summary
-
-<!-- Brief description of what this PR does. 1-3 bullet points. -->
-
--
-
-## Changes
-
-<!-- What was changed and how. List specific modifications. -->
-
+What changed, and why was it needed?

+ 3 - 0
README.md

@@ -27,6 +27,8 @@ To explore the agents themselves, see **[Meet the Pantheon](#meet-the-pantheon)*
 bunx oh-my-opencode-slim@latest install
 ```
 
+For bug reports and feature requests, use GitHub Issues. For setup questions, troubleshooting, or general support, use the Telegram channel linked above.
+
 ### Getting Started
 
 The installer generates an OpenAI preset by default, using `openai/gpt-5.4` for the higher-judgment agents and `openai/gpt-5.4-mini` for the faster scoped agents.
@@ -463,6 +465,7 @@ Use this section as a map: start with installation, then jump to features, confi
 | Doc | What it covers |
 |-----|----------------|
 | **[Configuration](docs/configuration.md)** | Config file locations, JSONC support, prompt overrides, and full option reference |
+| **[Maintainer Guide](docs/maintainers.md)** | Issue triage rules, label meanings, support routing, and repo maintenance workflow |
 | **[Skills](docs/skills.md)** | Built-in and recommended skills such as `simplify`, `agent-browser`, and `cartography` |
 | **[MCPs](docs/mcps.md)** | `websearch`, `context7`, `grep_app`, and how MCP permissions work per agent |
 | **[Tools](docs/tools.md)** | Built-in tool capabilities like background tasks, `webfetch`, LSP tools, code search, and formatters |

+ 120 - 0
docs/maintainers.md

@@ -0,0 +1,120 @@
+# Maintainer Guide
+
+This document is the source of truth for issue triage and lightweight repo maintenance in `oh-my-opencode-slim`.
+
+## Goals
+
+- Keep bug reports actionable.
+- Keep issue filing lightweight.
+- Keep support out of the issue tracker.
+- Keep maintainer decisions fast and consistent.
+
+## Where Different Things Go
+
+### GitHub Issues
+
+Use issues for:
+
+- bug reports
+- feature requests
+
+### Telegram
+
+Use the Telegram channel for:
+
+- setup questions
+- troubleshooting help
+- general support
+- open-ended usage questions
+
+If an issue is really a support request, reply briefly and redirect the user to Telegram.
+
+## Issue Forms
+
+### Bug report
+
+Bug reports should include:
+
+- what happened
+- what was expected
+- steps to reproduce
+- relevant config
+- OpenCode version
+- `oh-my-opencode-slim` version
+- operating system
+- logs, screenshots, or extra context if relevant
+
+The goal is enough information to reproduce the issue without turning the form into paperwork.
+
+### Feature request
+
+Feature requests should stay lightweight and focus on:
+
+- the problem
+- the requested change
+- optional extra context
+
+## Labels
+
+Only use these labels:
+
+- `bug` — bug report
+- `enhancement` — feature request or improvement
+- `needs-info` — cannot act yet because key details are missing
+- `confirmed` — a maintainer confirmed the issue or agrees the request is valid
+- `P0` — highest priority
+- `Share Your Thoughts` — open-ended feedback from the community
+
+If a label does not help triage or prioritization, do not add it.
+
+## Triage Flow
+
+For each new issue, make a quick first decision:
+
+1. Is it a bug report, a feature request, or support?
+2. Is there enough information to act on it?
+3. Is it confirmed?
+
+### Bug reports
+
+- Add `bug` if needed.
+- Add `needs-info` if required details are missing.
+- Add `confirmed` once a maintainer reproduces it or agrees it is valid and actionable.
+- Add `P0` only for the highest-priority problems.
+
+### Feature requests
+
+- Add `enhancement` if needed.
+- Add `confirmed` when maintainers agree it is a valid direction worth tracking.
+- Add `P0` only if it is truly urgent.
+
+### Support issues
+
+- Reply briefly.
+- Redirect the user to Telegram.
+- Close if needed.
+
+## Closing Policy
+
+- Close issues manually for now.
+- Do not use stale-bot automation.
+- If an issue lacks the details needed to proceed, ask for the missing information clearly and keep the ask short.
+
+## Pull Requests
+
+PRs use a minimal prompt:
+
+> What changed, and why was it needed?
+
+The goal is clarity without process overhead.
+
+## Future Changes
+
+If issue volume or maintainer load changes, this document can grow to include:
+
+- more labels
+- stronger prioritization rules
+- stale policies
+- contributor workflow guidance
+
+Until then, keep the system slim.