Skip to content

Commit de7484b

Browse files
raivisdejusraivisdejus
authored
Adding github issue template (#1700)
1 parent 69b930e commit de7484b

7 files changed

Lines changed: 151 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: Bug report
2+
description: Report a problem with the Buzz app installed on your computer
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Buzz is a desktop app.** Uploading audio or video files here will not transcribe them.
9+
To transcribe a file, [install Buzz](https://chidiwilliams.github.io/buzz/docs/installation) on your computer.
10+
11+
Before reporting, please check the [FAQ](https://chidiwilliams.github.io/buzz/docs/faq) and search [existing issues](https://github.com/chidiwilliams/buzz/issues).
12+
- type: checkboxes
13+
id: confirm
14+
attributes:
15+
label: Confirmation
16+
options:
17+
- label: I have installed Buzz on my computer and I am reporting a problem with the app. I understand that files uploaded here are not transcribed.
18+
required: true
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: What happened?
23+
description: Describe the problem and what you expected to happen instead.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: steps
28+
attributes:
29+
label: Steps to reproduce
30+
placeholder: |
31+
1. Open Buzz
32+
2. Select ...
33+
3. Click ...
34+
validations:
35+
required: true
36+
- type: input
37+
id: version
38+
attributes:
39+
label: Buzz version
40+
description: Found in Help -> About Buzz
41+
placeholder: e.g. 1.4.5
42+
validations:
43+
required: true
44+
- type: dropdown
45+
id: os
46+
attributes:
47+
label: Operating system
48+
options:
49+
- Windows
50+
- macOS
51+
- Linux
52+
validations:
53+
required: true
54+
- type: input
55+
id: os-version
56+
attributes:
57+
label: Operating system version
58+
placeholder: e.g. Windows 11 24H2, macOS 15.5, Ubuntu 24.04
59+
validations:
60+
required: true
61+
- type: dropdown
62+
id: install-method
63+
attributes:
64+
label: How did you install Buzz?
65+
options:
66+
- Windows installer
67+
- macOS .dmg
68+
- Mac App Store
69+
- Flatpak
70+
- Snap
71+
- AppImage
72+
- PyPI (pip install buzz-captions)
73+
- From source
74+
- Other
75+
validations:
76+
required: true
77+
- type: input
78+
id: model
79+
attributes:
80+
label: Model
81+
description: Model type and size used, if relevant
82+
placeholder: e.g. Whisper.cpp large-v3-turbo, Faster Whisper medium
83+
- type: input
84+
id: hardware
85+
attributes:
86+
label: Hardware
87+
description: CPU / GPU, if relevant (e.g. for performance or GPU acceleration problems)
88+
placeholder: e.g. Apple M2, NVIDIA RTX 3060, Intel i5 with integrated graphics
89+
- type: textarea
90+
id: logs
91+
attributes:
92+
label: Logs
93+
description: |
94+
To open the logs folder go to `Help -> About Buzz` and click `Show logs`. Paste relevant parts of the log file here, or drag and drop the log file.
95+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: I want to transcribe an audio or video file
4+
url: https://chidiwilliams.github.io/buzz/docs/installation
5+
about: Buzz is a desktop app that you install on your computer. Files uploaded to GitHub issues are NOT transcribed. Follow this link to download and install Buzz.
6+
- name: Questions and help
7+
url: https://github.com/chidiwilliams/buzz/discussions
8+
about: Ask questions about using Buzz and share ideas in GitHub Discussions.
9+
- name: Documentation and FAQ
10+
url: https://chidiwilliams.github.io/buzz/docs/faq
11+
about: Answers to common problems.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature request
2+
description: Suggest an improvement or new feature for the Buzz app
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Buzz is a desktop app.** Uploading audio or video files here will not transcribe them.
9+
To transcribe a file, [install Buzz](https://chidiwilliams.github.io/buzz/docs/installation) on your computer.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: What problem would this solve?
14+
description: Describe what you are trying to do and why the current app does not support it well.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Proposed solution
21+
description: How would you like this to work?
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Alternatives considered

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
Transcribe and translate audio offline on your personal computer. Powered by
88
OpenAI's [Whisper](https://github.com/openai/whisper).
99

10+
> [!IMPORTANT]
11+
> Buzz is a desktop app that you [install on your computer](#installation).
12+
> Uploading audio or video files to GitHub issues will **not** transcribe them.
13+
1014
![MIT License](https://img.shields.io/badge/license-MIT-green)
1115
[![CI](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml/badge.svg)](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml)
1216
[![codecov](https://codecov.io/github/chidiwilliams/buzz/branch/main/graph/badge.svg?token=YJSB8S2VEP)](https://codecov.io/github/chidiwilliams/buzz)

‎docs/docs/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ sidebar_position: 1
66
Transcribe and translate audio offline on your personal computer. Powered by
77
OpenAI's [Whisper](https://github.com/openai/whisper).
88

9+
:::info
10+
Buzz is a desktop app that you [install on your computer](installation.md).
11+
Uploading audio or video files to GitHub issues will **not** transcribe them.
12+
:::
13+
914
![MIT License](https://img.shields.io/badge/license-MIT-green)
1015
[![CI](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml/badge.svg)](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml)
1116
[![codecov](https://codecov.io/github/chidiwilliams/buzz/branch/main/graph/badge.svg?token=YJSB8S2VEP)](https://codecov.io/github/chidiwilliams/buzz)

‎docs/i18n/zh/docusaurus-plugin-content-docs/current/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ sidebar_position: 1
55

66
在您的个人电脑上离线转录和翻译音频。由 OpenAI 的 [Whisper](https://github.com/openai/whisper) 提供支持。
77

8+
:::info
9+
Buzz 是一款需要[安装到电脑上](installation.md)的桌面应用。
10+
将音频或视频文件上传到 GitHub issue **不会**进行转录。
11+
:::
12+
813
![MIT License](https://img.shields.io/badge/license-MIT-green)
914
[![CI](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml/badge.svg)](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml)
1015
[![codecov](https://codecov.io/github/chidiwilliams/buzz/branch/main/graph/badge.svg?token=YJSB8S2VEP)](https://codecov.io/github/chidiwilliams/buzz)

‎readme/README.zh_CN.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
在个人电脑上离线转录和翻译音频。技术模型来源 OpenAI [Whisper](https://github.com/openai/whisper).
88

9+
> [!IMPORTANT]
10+
> Buzz 是一款需要[安装到电脑上](https://chidiwilliams.github.io/buzz/zh/docs/installation)的桌面应用。
11+
> 将音频或视频文件上传到 GitHub issue **不会**进行转录。
12+
913
![MIT License](https://img.shields.io/badge/license-MIT-green)
1014
[![CI](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml/badge.svg)](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml)
1115
[![codecov](https://codecov.io/github/chidiwilliams/buzz/branch/main/graph/badge.svg?token=YJSB8S2VEP)](https://codecov.io/github/chidiwilliams/buzz)

0 commit comments

Comments
 (0)