Add GitHub issue templates #1224
Conversation
Most importantly, the bug report template is now asking for the user’s OS, Swift version and logging.
Since we now have a `.github` folder for issue templates, we can move `CODEOWNERS` to it.
|
@swift-ci Please test |
| description: Which text editor are you using? | ||
| placeholder: Eg. Visual Studio Code with Swift plugin 1.9.0, neovim |
There was a problem hiding this comment.
| description: Which text editor are you using? | |
| placeholder: Eg. Visual Studio Code with Swift plugin 1.9.0, neovim | |
| description: Which text editor are you using (and LSP extension/plugin if applicable)? | |
| placeholder: Eg. Visual Studio Code with Swift extension 1.9.0, Neovim, etc. |
There was a problem hiding this comment.
I think etc. isn’t necessary because we already have E.g. at the start of the placeholder.
There was a problem hiding this comment.
Was more the extension/plugin. I don't mind if you add the etc or not :)
| 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.
| The generated bundle might contain portions of your source code, so please only attach it if you feel comfortable sharing it. | |
| The generated bundle may contain paths to files on disk as well as portions of your source code. This greatly helps in reproducing issues, but you should only attach it if you feel comfortable doing so. |
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 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 |
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?
Most importantly, the bug report template is now asking for the user’s OS, Swift version and logging.