Add GitHub issue templates #1224
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,53 @@ | ||||||
| name: Bug Report | ||||||
| description: Something isn't working as expected | ||||||
| labels: [bug] | ||||||
| body: | ||||||
| - type: input | ||||||
| id: version | ||||||
| attributes: | ||||||
| label: Swift version | ||||||
| description: Which version of Swift are you using? If you are unsure, insert the output of `path/to/swift --version` | ||||||
| placeholder: Eg. swiftlang-5.10.0.13, swift-DEVELOPMENT-SNAPSHOT-2024-05-01-a | ||||||
| - type: input | ||||||
| id: platform | ||||||
| attributes: | ||||||
| label: Platform | ||||||
| description: What operating system are you seeing the issue on? | ||||||
| placeholder: Eg. Ubuntu 22.04, Windows 11, macOS 14 | ||||||
| - type: input | ||||||
| id: editor | ||||||
| attributes: | ||||||
| label: Editor | ||||||
| description: Which text editor are you using? | ||||||
| placeholder: Eg. Visual Studio Code with Swift plugin 1.9.0, neovim | ||||||
| - type: dropdown | ||||||
| id: reproduces-with-swift-6 | ||||||
| attributes: | ||||||
| label: Does the issue reproduce with Swift 6? | ||||||
| description: | | ||||||
| Does the issue also reproduce using a [recent Swift 6 Development Snapshot](https://www.swift.org/download/#swift-60-development)? | ||||||
|
|
||||||
| 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. | ||||||
| options: | ||||||
| - "Yes" | ||||||
| - "No" | ||||||
| - I didn’t try | ||||||
| - type: textarea | ||||||
| id: description | ||||||
| attributes: | ||||||
| label: Description | ||||||
| description: | | ||||||
| A short description of the incorrect behavior. | ||||||
| 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. | ||||||
| - type: textarea | ||||||
| id: steps-to-reproduce | ||||||
| attributes: | ||||||
| label: Steps to Reproduce | ||||||
| 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. | ||||||
| - type: textarea | ||||||
| id: logging | ||||||
| attributes: | ||||||
| label: Logging | ||||||
| description: | | ||||||
| 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. | ||||||
| The generated bundle might contain portions of your source code, so please only attach it if you feel comfortable sharing it. | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Do we/should we relativize paths based on the workspace root if we're able to? There was a problem hiding this comment. I don’t think relativizing paths makes much sense. The last path component already contains the file’s name, which might be as sensitive as other parts of the path. And relativizing them might make it harder to diagnose issues. So, I would say nearly no benefit with potential loss of diagnosability, so not worth it. There was a problem hiding this comment. It could be that the project itself is opensource (so there's no concerns about source), but eg. absolute paths could have their home directory name which could be sensitive. There was a problem hiding this comment. I doubt that’s a common. You are already sharing your name by filing a GitHub issue and in most cases I expect your GitHub name to be somewhat similar to your username. So, I don’t think it’s something to optimize for until the issue comes up. |
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| name: Feature Request | ||
| description: A suggestion for a new feature | ||
| labels: [enhancement] | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: | | ||
| A description of your proposed feature. | ||
| Examples that show what's missing, or what new capabilities will be possible, are very helpful! | ||
| If this feature unlocks new use-cases please describe them. | ||
| Provide links to existing issues or external references/discussions, if appropriate. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # This source file is part of the Swift.org open source project | ||
| # | ||
| # Copyright (c) 2024 Apple Inc. and the Swift project authors | ||
| # Licensed under Apache License v2.0 with Runtime Library Exception | ||
| # | ||
| # See https://swift.org/LICENSE.txt for license information | ||
| # See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
|
Comment on lines
+1
to
+7
There was a problem hiding this comment. Why copyright on this and not the others? There was a problem hiding this comment. I was following what swift-syntax did… Any preference if all or none should have copyright headers? |
||
|
|
||
| contact_links: | ||
| - name: Discussion Forum | ||
| url: https://forums.swift.org/c/development/sourcekit-lsp | ||
| about: Ask and answer questions about SourceKit-LSP | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think
etc.isn’t necessary because we already haveE.g.at the start of the placeholder.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was more the extension/plugin. I don't mind if you add the etc or not :)