Skip to content

Commit 01ebc32

Browse files
ISSUE_TEMPLATE (#147)
1 parent 069b78d commit 01ebc32

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
labels: [triage]
4+
assignees: [alan-george-lk, stephen-derosa]
5+
body:
6+
- type: input
7+
id: sdk-version
8+
validations: { required: true }
9+
attributes:
10+
label: LiveKit C++ SDK Version
11+
description: What version (or commit SHA) of the LiveKit C++ SDK are you using?
12+
placeholder: "v1.0.0"
13+
- type: dropdown
14+
id: platform
15+
validations: { required: true }
16+
attributes:
17+
label: Platform
18+
description: On which platform did you encounter the issue?
19+
options:
20+
- Linux x86_64
21+
- Linux arm64
22+
- macOS x86_64 (Intel)
23+
- macOS arm64 (Apple Silicon)
24+
- Windows x64
25+
- Other (describe below)
26+
- type: input
27+
id: os-version
28+
validations: { required: true }
29+
attributes:
30+
label: OS Version
31+
description: What operating system version are you running?
32+
placeholder: "Ubuntu 22.04 / macOS 14.5 / Windows 11"
33+
- type: input
34+
id: compiler
35+
validations: { required: true }
36+
attributes:
37+
label: Compiler & Version
38+
description: Which compiler and version are you building with?
39+
placeholder: "clang 17 / gcc 13 / MSVC 19.39"
40+
- type: input
41+
id: cmake-version
42+
validations: { required: true }
43+
attributes:
44+
label: CMake Version
45+
description: Output of `cmake --version` (must be ≥ 3.20).
46+
placeholder: "3.28.1"
47+
- type: dropdown
48+
id: consumption
49+
validations: { required: true }
50+
attributes:
51+
label: How are you using the SDK?
52+
description: Are you building from source or consuming a pre-built release?
53+
options:
54+
- Building from source (build.sh / build.cmd)
55+
- Pre-built release package (find_package(LiveKit CONFIG))
56+
- Other (describe below)
57+
- type: textarea
58+
id: description
59+
validations: { required: true }
60+
attributes:
61+
label: Issue Description
62+
description: |
63+
Please describe the issue, including what you expected to happen and what
64+
actually happened. Provide any relevant logs and code snippets.
65+
- type: textarea
66+
id: reproduction
67+
validations: { required: false }
68+
attributes:
69+
label: Steps to Reproduce
70+
description: |
71+
A minimal set of steps (and, if possible, a code snippet) that reliably
72+
reproduces the issue.
73+
- type: textarea
74+
id: logs
75+
validations: { required: false }
76+
attributes:
77+
label: Logs
78+
description: |
79+
Relevant SDK logs. Setting the log level to debug via `setLogLevel`
80+
(`include/livekit/logging.h`) often provides useful detail.
81+
render: shell

.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: Developer Community
4+
url: https://community.livekit.io/
5+
about: Ask questions, suggest improvements, and discuss contributions
6+
- name: LiveKit Documentation
7+
url: https://docs.livekit.io/
8+
about: Check the docs before filing an issue

0 commit comments

Comments
 (0)