Skip to content

Commit 73b2e26

Browse files
committed
Add GitHub issue templates
Most importantly, the bug report template is now asking for the user’s OS, Swift version and logging.
1 parent e71aa5d commit 73b2e26

File tree

3 files changed

+78
-0
lines changed

3 files changed

+78
-0
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [bug]
4+
body:
5+
- type: input
6+
id: version
7+
attributes:
8+
label: Swift version
9+
description: Which version of Swift are you using? If you are unsure, insert the output of `path/to/swift --version`
10+
placeholder: Eg. swiftlang-5.10.0.13, swift-DEVELOPMENT-SNAPSHOT-2024-05-01-a
11+
- type: input
12+
id: platform
13+
attributes:
14+
label: Platform
15+
description: What operating system are you seeing the issue on?
16+
placeholder: Eg. Ubuntu 22.04, Windows 11, macOS 14
17+
- type: input
18+
id: editor
19+
attributes:
20+
label: Editor
21+
description: Which text editor are you using?
22+
placeholder: Eg. Visual Studio Code with Swift plugin 1.9.0, neovim
23+
- type: dropdown
24+
id: reproduces-with-swift-6
25+
attributes:
26+
label: Does the issue reproduce with Swift 6?
27+
description: |
28+
Does the issue also reproduce using a [recent Swift 6 Development Snapshot](https://www.swift.org/download/#swift-60-development)?
29+
30+
We have made significant changes to SourceKit-LSP in Swift 6 and the issue might have already been fixed. If you didn’t try, that is fine.
31+
options:
32+
- "Yes"
33+
- "No"
34+
- I didn’t try
35+
- type: textarea
36+
id: description
37+
attributes:
38+
label: Description
39+
description: |
40+
A short description of the incorrect behavior.
41+
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
42+
- type: textarea
43+
id: steps-to-reproduce
44+
attributes:
45+
label: Steps to Reproduce
46+
description: If you have steps that reproduce the issue, please add them here. If you can share a project that reproduces the issue, please attach it.
47+
- type: textarea
48+
id: logging
49+
attributes:
50+
label: Logging
51+
description: |
52+
If you are using SourceKit-LSP from Swift 6, running `sourcekit-lsp diagnose` in terminal and attaching the generated bundle helps us diagnose the issue.
53+
The generated bundle might contain portions of your source code, so please only attach it if you feel comfortable sharing it.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Feature Request
2+
description: A suggestion for a new feature
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: |
10+
A description of your proposed feature.
11+
Examples that show what's missing, or what new capabilities will be possible, are very helpful!
12+
If this feature unlocks new use-cases please describe them.
13+
Provide links to existing issues or external references/discussions, if appropriate.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2024 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See https://swift.org/LICENSE.txt for license information
7+
# See https://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
contact_links:
10+
- name: Discussion Forum
11+
url: https://forums.swift.org/c/development/sourcekit-lsp
12+
about: Ask and answer questions about SourceKit-LSP

0 commit comments

Comments
 (0)