From 5aa0ee125db5a4be2475b95352a891bc27cb28aa Mon Sep 17 00:00:00 2001 From: Sisyphus Date: Tue, 6 Jan 2026 17:13:06 +0900 Subject: [PATCH] feat: add English language policy and GitHub issue templates (#534) --- .github/ISSUE_TEMPLATE/bug_report.yml | 129 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 100 ++++++++++++++++ .github/ISSUE_TEMPLATE/general.yml | 83 +++++++++++++ CONTRIBUTING.md | 23 ++++ 5 files changed, 343 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/general.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ff287f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,129 @@ +name: Bug Report +description: Report a bug or unexpected behavior in oh-my-opencode +title: "[Bug]: " +labels: ["bug", "needs-triage"] +body: + - type: markdown + attributes: + value: | + **Please write your issue in English.** See our [Language Policy](https://github.com/code-yeongyu/oh-my-opencode/blob/dev/CONTRIBUTING.md#language-policy) for details. + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm the following before submitting + options: + - label: I have searched existing issues to avoid duplicates + required: true + - label: I am using the latest version of oh-my-opencode + required: true + - label: I have read the [documentation](https://github.com/code-yeongyu/oh-my-opencode#readme) + required: true + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is + placeholder: Describe the bug in detail... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Configure oh-my-opencode with... + 2. Run command '...' + 3. See error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: Describe what should happen... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + placeholder: Describe what actually happened... + validations: + required: true + + - type: textarea + id: doctor + attributes: + label: Doctor Output + description: | + **Required:** Run `bunx oh-my-opencode doctor` and paste the full output below. + This helps us diagnose your environment and configuration. + placeholder: | + Paste the output of: bunx oh-my-opencode doctor + + Example: + ✓ OpenCode version: 1.0.150 + ✓ oh-my-opencode version: 1.2.3 + ✓ Plugin loaded successfully + ... + render: shell + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Error Logs + description: If applicable, add any error messages or logs + placeholder: Paste error logs here... + render: shell + + - type: textarea + id: config + attributes: + label: Configuration + description: If relevant, share your oh-my-opencode configuration (remove sensitive data) + placeholder: | + { + "agents": { ... }, + "disabled_hooks": [ ... ] + } + render: json + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context about the problem + placeholder: Add any other context, screenshots, or information... + + - type: dropdown + id: os + attributes: + label: Operating System + description: Which operating system are you using? + options: + - macOS + - Linux + - Windows + - Other + validations: + required: true + + - type: input + id: opencode-version + attributes: + label: OpenCode Version + description: Run `opencode --version` to get your version + placeholder: "1.0.150" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..f161966 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discord Community + url: https://discord.gg/PUwSMR9XNk + about: Join our Discord server for real-time discussions and community support + - name: Documentation + url: https://github.com/code-yeongyu/oh-my-opencode#readme + about: Read the comprehensive documentation and guides diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..a0d3b02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,100 @@ +name: Feature Request +description: Suggest a new feature or enhancement for oh-my-opencode +title: "[Feature]: " +labels: ["enhancement", "needs-triage"] +body: + - type: markdown + attributes: + value: | + **Please write your issue in English.** See our [Language Policy](https://github.com/code-yeongyu/oh-my-opencode/blob/dev/CONTRIBUTING.md#language-policy) for details. + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm the following before submitting + options: + - label: I have searched existing issues and discussions to avoid duplicates + required: true + - label: This feature request is specific to oh-my-opencode (not OpenCode core) + required: true + - label: I have read the [documentation](https://github.com/code-yeongyu/oh-my-opencode#readme) + required: true + + - type: textarea + id: problem + attributes: + label: Problem Description + description: What problem does this feature solve? What's the use case? + placeholder: | + Describe the problem or limitation you're experiencing... + Example: "As a user, I find it difficult to..." + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe how you'd like this feature to work + placeholder: | + Describe your proposed solution in detail... + Example: "Add a new hook that..." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + placeholder: | + Describe any alternative solutions you've considered... + Example: "I tried using X but it didn't work because..." + + - type: textarea + id: doctor + attributes: + label: Doctor Output (Optional) + description: | + If relevant to your feature request, run `bunx oh-my-opencode doctor` and paste the output. + This helps us understand your environment. + placeholder: | + Paste the output of: bunx oh-my-opencode doctor + (Optional for feature requests) + render: shell + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context, mockups, or examples + placeholder: | + Add any other context, screenshots, code examples, or links... + Examples from other tools/projects are helpful! + + - type: dropdown + id: feature-type + attributes: + label: Feature Type + description: What type of feature is this? + options: + - New Agent + - New Hook + - New Tool + - New MCP Integration + - Configuration Option + - Documentation + - Other + validations: + required: true + + - type: checkboxes + id: contribution + attributes: + label: Contribution + description: Are you willing to contribute to this feature? + options: + - label: I'm willing to submit a PR for this feature + - label: I can help with testing + - label: I can help with documentation diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml new file mode 100644 index 0000000..24d933b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -0,0 +1,83 @@ +name: Question or Discussion +description: Ask a question or start a discussion about oh-my-opencode +title: "[Question]: " +labels: ["question", "needs-triage"] +body: + - type: markdown + attributes: + value: | + **Please write your issue in English.** See our [Language Policy](https://github.com/code-yeongyu/oh-my-opencode/blob/dev/CONTRIBUTING.md#language-policy) for details. + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm the following before submitting + options: + - label: I have searched existing issues and discussions + required: true + - label: I have read the [documentation](https://github.com/code-yeongyu/oh-my-opencode#readme) + required: true + - label: This is a question (not a bug report or feature request) + required: true + + - type: textarea + id: question + attributes: + label: Question + description: What would you like to know or discuss? + placeholder: | + Ask your question in detail... + + Examples: + - How do I configure agent X to do Y? + - What's the best practice for Z? + - Why does feature A work differently than B? + validations: + required: true + + - type: textarea + id: context + attributes: + label: Context + description: Provide any relevant context or background + placeholder: | + What have you tried so far? + What's your use case? + Any relevant configuration or setup details? + + - type: textarea + id: doctor + attributes: + label: Doctor Output (Optional) + description: | + If your question is about configuration or setup, run `bunx oh-my-opencode doctor` and paste the output. + placeholder: | + Paste the output of: bunx oh-my-opencode doctor + (Optional for questions) + render: shell + + - type: dropdown + id: category + attributes: + label: Question Category + description: What is your question about? + options: + - Configuration + - Agent Usage + - Hook Behavior + - Tool Usage + - Installation/Setup + - Best Practices + - Performance + - Integration + - Other + validations: + required: true + + - type: textarea + id: additional + attributes: + label: Additional Information + description: Any other information that might be helpful + placeholder: Links, screenshots, examples, etc. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b47e221..0094788 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,29 @@ First off, thanks for taking the time to contribute! This document provides guid Be respectful, inclusive, and constructive. We're all here to make better tools together. +## Language Policy + +**English is the primary language for all communications in this repository.** + +This includes: +- Issues and bug reports +- Pull requests and code reviews +- Documentation and comments +- Discussions and community interactions + +### Why English? + +- **Global Accessibility**: English allows contributors from all regions to collaborate effectively +- **Consistency**: A single language keeps discussions organized and searchable +- **Open Source Best Practice**: Most successful open-source projects use English as the lingua franca + +### Need Help with English? + +If English isn't your first language, don't worry! We value your contributions regardless of perfect grammar. You can: +- Use translation tools to help compose messages +- Ask for help from other community members +- Focus on clear, simple communication rather than perfect prose + ## Getting Started ### Prerequisites