Skip to content

Commit 5aa0ee1

Browse files
sisyphus-dev-aisisyphus-dev-ai
authored
feat: add English language policy and GitHub issue templates (#534)
1 parent d0b3be7 commit 5aa0ee1

File tree

5 files changed

+343
-0
lines changed

5 files changed

+343
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in oh-my-opencode
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**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.
10+
11+
- type: checkboxes
12+
id: prerequisites
13+
attributes:
14+
label: Prerequisites
15+
description: Please confirm the following before submitting
16+
options:
17+
- label: I have searched existing issues to avoid duplicates
18+
required: true
19+
- label: I am using the latest version of oh-my-opencode
20+
required: true
21+
- label: I have read the [documentation](https://github.com/code-yeongyu/oh-my-opencode#readme)
22+
required: true
23+
24+
- type: textarea
25+
id: description
26+
attributes:
27+
label: Bug Description
28+
description: A clear and concise description of what the bug is
29+
placeholder: Describe the bug in detail...
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: reproduction
35+
attributes:
36+
label: Steps to Reproduce
37+
description: Steps to reproduce the behavior
38+
placeholder: |
39+
1. Configure oh-my-opencode with...
40+
2. Run command '...'
41+
3. See error...
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: Expected Behavior
49+
description: What did you expect to happen?
50+
placeholder: Describe what should happen...
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: actual
56+
attributes:
57+
label: Actual Behavior
58+
description: What actually happened?
59+
placeholder: Describe what actually happened...
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: doctor
65+
attributes:
66+
label: Doctor Output
67+
description: |
68+
**Required:** Run `bunx oh-my-opencode doctor` and paste the full output below.
69+
This helps us diagnose your environment and configuration.
70+
placeholder: |
71+
Paste the output of: bunx oh-my-opencode doctor
72+
73+
Example:
74+
✓ OpenCode version: 1.0.150
75+
✓ oh-my-opencode version: 1.2.3
76+
✓ Plugin loaded successfully
77+
...
78+
render: shell
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: logs
84+
attributes:
85+
label: Error Logs
86+
description: If applicable, add any error messages or logs
87+
placeholder: Paste error logs here...
88+
render: shell
89+
90+
- type: textarea
91+
id: config
92+
attributes:
93+
label: Configuration
94+
description: If relevant, share your oh-my-opencode configuration (remove sensitive data)
95+
placeholder: |
96+
{
97+
"agents": { ... },
98+
"disabled_hooks": [ ... ]
99+
}
100+
render: json
101+
102+
- type: textarea
103+
id: context
104+
attributes:
105+
label: Additional Context
106+
description: Any other context about the problem
107+
placeholder: Add any other context, screenshots, or information...
108+
109+
- type: dropdown
110+
id: os
111+
attributes:
112+
label: Operating System
113+
description: Which operating system are you using?
114+
options:
115+
- macOS
116+
- Linux
117+
- Windows
118+
- Other
119+
validations:
120+
required: true
121+
122+
- type: input
123+
id: opencode-version
124+
attributes:
125+
label: OpenCode Version
126+
description: Run `opencode --version` to get your version
127+
placeholder: "1.0.150"
128+
validations:
129+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord Community
4+
url: https://discord.gg/PUwSMR9XNk
5+
about: Join our Discord server for real-time discussions and community support
6+
- name: Documentation
7+
url: https://github.com/code-yeongyu/oh-my-opencode#readme
8+
about: Read the comprehensive documentation and guides

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for oh-my-opencode
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**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.
10+
11+
- type: checkboxes
12+
id: prerequisites
13+
attributes:
14+
label: Prerequisites
15+
description: Please confirm the following before submitting
16+
options:
17+
- label: I have searched existing issues and discussions to avoid duplicates
18+
required: true
19+
- label: This feature request is specific to oh-my-opencode (not OpenCode core)
20+
required: true
21+
- label: I have read the [documentation](https://github.com/code-yeongyu/oh-my-opencode#readme)
22+
required: true
23+
24+
- type: textarea
25+
id: problem
26+
attributes:
27+
label: Problem Description
28+
description: What problem does this feature solve? What's the use case?
29+
placeholder: |
30+
Describe the problem or limitation you're experiencing...
31+
Example: "As a user, I find it difficult to..."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Proposed Solution
39+
description: Describe how you'd like this feature to work
40+
placeholder: |
41+
Describe your proposed solution in detail...
42+
Example: "Add a new hook that..."
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives Considered
50+
description: Have you considered any alternative solutions or workarounds?
51+
placeholder: |
52+
Describe any alternative solutions you've considered...
53+
Example: "I tried using X but it didn't work because..."
54+
55+
- type: textarea
56+
id: doctor
57+
attributes:
58+
label: Doctor Output (Optional)
59+
description: |
60+
If relevant to your feature request, run `bunx oh-my-opencode doctor` and paste the output.
61+
This helps us understand your environment.
62+
placeholder: |
63+
Paste the output of: bunx oh-my-opencode doctor
64+
(Optional for feature requests)
65+
render: shell
66+
67+
- type: textarea
68+
id: context
69+
attributes:
70+
label: Additional Context
71+
description: Any other context, mockups, or examples
72+
placeholder: |
73+
Add any other context, screenshots, code examples, or links...
74+
Examples from other tools/projects are helpful!
75+
76+
- type: dropdown
77+
id: feature-type
78+
attributes:
79+
label: Feature Type
80+
description: What type of feature is this?
81+
options:
82+
- New Agent
83+
- New Hook
84+
- New Tool
85+
- New MCP Integration
86+
- Configuration Option
87+
- Documentation
88+
- Other
89+
validations:
90+
required: true
91+
92+
- type: checkboxes
93+
id: contribution
94+
attributes:
95+
label: Contribution
96+
description: Are you willing to contribute to this feature?
97+
options:
98+
- label: I'm willing to submit a PR for this feature
99+
- label: I can help with testing
100+
- label: I can help with documentation

‎.github/ISSUE_TEMPLATE/general.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Question or Discussion
2+
description: Ask a question or start a discussion about oh-my-opencode
3+
title: "[Question]: "
4+
labels: ["question", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**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.
10+
11+
- type: checkboxes
12+
id: prerequisites
13+
attributes:
14+
label: Prerequisites
15+
description: Please confirm the following before submitting
16+
options:
17+
- label: I have searched existing issues and discussions
18+
required: true
19+
- label: I have read the [documentation](https://github.com/code-yeongyu/oh-my-opencode#readme)
20+
required: true
21+
- label: This is a question (not a bug report or feature request)
22+
required: true
23+
24+
- type: textarea
25+
id: question
26+
attributes:
27+
label: Question
28+
description: What would you like to know or discuss?
29+
placeholder: |
30+
Ask your question in detail...
31+
32+
Examples:
33+
- How do I configure agent X to do Y?
34+
- What's the best practice for Z?
35+
- Why does feature A work differently than B?
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: context
41+
attributes:
42+
label: Context
43+
description: Provide any relevant context or background
44+
placeholder: |
45+
What have you tried so far?
46+
What's your use case?
47+
Any relevant configuration or setup details?
48+
49+
- type: textarea
50+
id: doctor
51+
attributes:
52+
label: Doctor Output (Optional)
53+
description: |
54+
If your question is about configuration or setup, run `bunx oh-my-opencode doctor` and paste the output.
55+
placeholder: |
56+
Paste the output of: bunx oh-my-opencode doctor
57+
(Optional for questions)
58+
render: shell
59+
60+
- type: dropdown
61+
id: category
62+
attributes:
63+
label: Question Category
64+
description: What is your question about?
65+
options:
66+
- Configuration
67+
- Agent Usage
68+
- Hook Behavior
69+
- Tool Usage
70+
- Installation/Setup
71+
- Best Practices
72+
- Performance
73+
- Integration
74+
- Other
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: additional
80+
attributes:
81+
label: Additional Information
82+
description: Any other information that might be helpful
83+
placeholder: Links, screenshots, examples, etc.

‎CONTRIBUTING.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,29 @@ First off, thanks for taking the time to contribute! This document provides guid
2626

2727
Be respectful, inclusive, and constructive. We're all here to make better tools together.
2828

29+
## Language Policy
30+
31+
**English is the primary language for all communications in this repository.**
32+
33+
This includes:
34+
- Issues and bug reports
35+
- Pull requests and code reviews
36+
- Documentation and comments
37+
- Discussions and community interactions
38+
39+
### Why English?
40+
41+
- **Global Accessibility**: English allows contributors from all regions to collaborate effectively
42+
- **Consistency**: A single language keeps discussions organized and searchable
43+
- **Open Source Best Practice**: Most successful open-source projects use English as the lingua franca
44+
45+
### Need Help with English?
46+
47+
If English isn't your first language, don't worry! We value your contributions regardless of perfect grammar. You can:
48+
- Use translation tools to help compose messages
49+
- Ask for help from other community members
50+
- Focus on clear, simple communication rather than perfect prose
51+
2952
## Getting Started
3053

3154
### Prerequisites

0 commit comments

Comments
 (0)