Skip to content

Commit 0cc91ab

Browse files
author
Reshad Ahammed Ayon
authored
feat: Add issue templates for bug reports and feature requests (#412)
* feat: Add issue templates * Add config.yml for better customization
1 parent be784f6 commit 0cc91ab

File tree

3 files changed

+150
-0
lines changed

3 files changed

+150
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
name: Bug Report
3+
description: File a bug report to help us improve OpenBangla Keyboard
4+
labels: ["bug"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for reporting a bug in OpenBangla Keyboard (OBK). Please provide as much detail as possible to help us diagnose and fix the issue.
11+
- type: input
12+
id: obk-version
13+
attributes:
14+
label: OBK Version
15+
description: What version of OpenBangla Keyboard are you using? (e.g., 3.0.0)
16+
placeholder: e.g., 3.0.0
17+
validations:
18+
required: true
19+
- type: input
20+
id: os-details
21+
attributes:
22+
label: Operating System
23+
description: Which Linux distribution and version are you using? (e.g., Ubuntu 24.04, Arch Linux)
24+
placeholder: e.g., Ubuntu 24.04
25+
validations:
26+
required: true
27+
- type: input
28+
id: environment-details
29+
attributes:
30+
label: Environment Details
31+
description: Which Linux destop environment and display type are you using? (e.g., GNOME Wayland, Plasma X11, Hyprland)
32+
placeholder: e.g., GNOME Wayland
33+
validations:
34+
required: true
35+
- type: dropdown
36+
id: input-method
37+
attributes:
38+
label: Input Method Framework
39+
description: Which input method framework are you using? (e.g., IBus, Fcitx)
40+
multiple: true
41+
options:
42+
- IBus
43+
- Fcitx
44+
- Other (please specify in Additional Context)
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: bug-description
49+
attributes:
50+
label: Describe the Bug
51+
description: A clear and concise description of what the bug is.
52+
placeholder: Tell us what you see!
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: steps-to-reproduce
57+
attributes:
58+
label: Steps to Reproduce
59+
description: Provide detailed steps to reproduce the bug.
60+
placeholder: |
61+
1. Open OBK
62+
2. Select a specific layout
63+
3. Type specific characters
64+
4. Observe the issue
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: expected-behavior
69+
attributes:
70+
label: Expected Behavior
71+
description: What did you expect to happen?
72+
placeholder: A clear and concise description of what you expected.
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: actual-behavior
77+
attributes:
78+
label: Actual Behavior
79+
description: What actually happened?
80+
placeholder: A clear and concise description of what occurred.
81+
validations:
82+
required: true
83+
- type: textarea
84+
id: logs
85+
attributes:
86+
label: Logs or Screenshots
87+
description: If applicable, please include relevant logs, screenshots, or other files to help explain the problem.
88+
placeholder: Paste logs here or describe how to access screenshots.
89+
validations:
90+
required: false
91+
- type: textarea
92+
id: additional-context
93+
attributes:
94+
label: Additional Context
95+
description: Any other context about the problem, such as specific keyboard layouts or system configurations.
96+
placeholder: Add any relevant details here.
97+
validations:
98+
required: false
99+
---

‎.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: true
2+
contact_links:
3+
- name: Got any questions?
4+
url: https://github.com/OpenBangla/OpenBangla-Keyboard/discussions/categories/q-a
5+
about: General inquiries or help with OpenBangla Keyboard.
6+
- name: Share your ideas!
7+
url: https://github.com/OpenBangla/OpenBangla-Keyboard/discussions/categories/ideas
8+
about: Suggest new features or improvements for the project.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Feature Request
3+
description: Suggest an idea for improving OpenBangla Keyboard
4+
labels: ["enhancement"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for suggesting an improvement for OpenBangla Keyboard (OBK). Please provide as much detail as possible to help us understand your idea.
11+
- type: textarea
12+
id: feature-description
13+
attributes:
14+
label: Describe the Feature
15+
description: A clear and concise description of the feature you'd like to see.
16+
placeholder: What feature would you like to add to OBK?
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: problem-solved
21+
attributes:
22+
label: Problem or Use Case
23+
description: What problem does this feature solve, or what use case does it address?
24+
placeholder: Describe the problem or scenario this feature would improve.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: proposed-solution
29+
attributes:
30+
label: Proposed Solution
31+
description: How do you envision this feature working? Provide details on the implementation or behavior.
32+
placeholder: Describe how you think this should work in OBK.
33+
validations:
34+
required: false
35+
- type: textarea
36+
id: additional-context
37+
attributes:
38+
label: Additional Context
39+
description: Any other details, such as specific keyboard layouts, user workflows, or examples from other software.
40+
placeholder: Add any relevant details or examples here.
41+
validations:
42+
required: false
43+
---

0 commit comments

Comments
 (0)