-
Notifications
You must be signed in to change notification settings - Fork 10.5k
.github: Migrate Markdown issue templates to YAML forms #69808
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
AnthonyLatsis
merged 4 commits into
swiftlang:main
from
AnthonyLatsis:migrate-to-issue-forms
Nov 27, 2023
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f187a56
.github: Migrate Markdown issue templates to YAML forms
AnthonyLatsis 47dbfd5
.github: Add an issue template for crashes
AnthonyLatsis 0e48733
.github: Add an issue template for tasks
AnthonyLatsis eac5c20
.github: Customize the issue template chooser with config file
AnthonyLatsis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# This source file is part of the Swift.org open source project | ||
# | ||
# Copyright (c) 2023 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 the list of Swift project authors | ||
|
||
name: 🪲 Report a bug | ||
description: > | ||
Report a deviation from expected or documented behavior, but not a crash. | ||
labels: [bug, triage needed] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
This repository hosts the Swift compiler, the Swift standard library, | ||
the Swift runtime, SourceKit, and IDE support for the Swift language. | ||
It does *not* track feedback on Xcode and other closed source Apple | ||
developer software such as SwiftUI and UIKit; please direct it to | ||
[Feedback Assistant](https://developer.apple.com/bug-reporting) | ||
instead. | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: > | ||
A concise description of what causes the problem, in human language. | ||
Though not required, it may help us to more accurately triage the issue | ||
as well as understand a non-trivial test case. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Reproduction | ||
description: > | ||
Provide a test case, preferably in a Markdown codeblock, and explain | ||
how to build or run it to reproduce the problem. If the problem is a | ||
poor or unexpected error, warning, fix-it, or output, please show | ||
them. Consider reducing the test case to the smallest amount of code | ||
possible — a smaller test case is easier to reason about and more | ||
appealing to contributors. | ||
value: | | ||
```swift | ||
|
||
``` | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: Describe the behavior you expected. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: > | ||
Provide the Swift version, tag, or revision. If you suspect that the | ||
problem might be specific to a particular development platform or | ||
deployment target, please specify them as well. | ||
placeholder: $ swiftc -version | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional information | ||
description: > | ||
Any complementary information that could help others to work around | ||
the problem, and us to better understand the problem and its impact. | ||
For example, a link to a discussion or post that motivated this | ||
report. | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
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,48 @@ | ||
# This source file is part of the Swift.org open source project | ||
# | ||
# Copyright (c) 2023 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 the list of Swift project authors | ||
|
||
blank_issues_enabled: true | ||
contact_links: | ||
- name: 🌐 Discuss an idea | ||
url: https://forums.swift.org/c/evolution/discuss | ||
about: > | ||
Share an idea with the Swift community. | ||
- name: 📄 Formally propose a change | ||
url: https://www.swift.org/swift-evolution | ||
about: > | ||
Formally propose an addition, removal, or change to the features of the | ||
Swift language or the public interface of the Swift standard library. | ||
- name: 🙋 Ask a question about Swift | ||
url: https://forums.swift.org/c/swift-users | ||
about: > | ||
Ask a question about or get help with the Swift language and its standard | ||
library. Beginner questions welcome! | ||
- name: 🙋 Ask a question about the Swift compiler | ||
url: https://forums.swift.org/c/development/compiler | ||
about: > | ||
Ask a question about or get help with contributing to the Swift compiler. | ||
- name: 🙋 Ask a question on the Apple Developer Forums | ||
url: https://developer.apple.com/forums | ||
about: > | ||
Ask a question about or get help with app development for Apple platforms | ||
in general. Topics include Xcode and other closed source Apple developer | ||
software such as SwiftUI and UIKit. | ||
- name: 🪲 Report an issue using Feedback Assistant | ||
url: https://developer.apple.com/bug-reporting | ||
about: > | ||
Report an issue with Xcode or other closed source Apple developer | ||
software such as SwiftUI and UIKit. | ||
- name: 🪲 Report an issue with The Swift Programming Language (the book) | ||
url: https://github.com/apple/swift-book/issues/new/choose | ||
about: > | ||
Like the Swift compiler and standard library, TSPL is open source and | ||
welcomes contributions. | ||
- name: 📖 Learn Swift | ||
url: https://docs.swift.org/swift-book/documentation/the-swift-programming-language | ||
about: > | ||
Read The Swift Programming Language, the official book on Swift. |
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,82 @@ | ||
# This source file is part of the Swift.org open source project | ||
# | ||
# Copyright (c) 2023 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 the list of Swift project authors | ||
|
||
name: 💥 Report a crash | ||
description: > | ||
Report a compiler crash or other unexpected program termination caused by an | ||
exception. | ||
labels: [bug, crash, triage needed] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
This repository hosts the Swift compiler, the Swift standard library, | ||
the Swift runtime, SourceKit, and IDE support for the Swift language. | ||
It does *not* track feedback on Xcode and other closed source Apple | ||
developer software such as SwiftUI and UIKit; please direct it to | ||
[Feedback Assistant](https://developer.apple.com/bug-reporting) | ||
instead. | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: > | ||
A concise description of what causes the problem, in human language. | ||
Though not required, it may help us to more accurately triage the issue | ||
as well as understand a non-trivial test case. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Reproduction | ||
description: > | ||
Provide a test case, preferably in a Markdown codeblock, and explain | ||
how to build or run it to reproduce the problem. Consider reducing the | ||
test case to the smallest amount of code possible — a smaller test case | ||
is easier to reason about and more appealing to contributors. | ||
value: | | ||
```swift | ||
|
||
``` | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Stack dump | ||
description: > | ||
Paste the stack dump as is, without formatting it into a Markdown | ||
codeblock. | ||
render: "text" | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: > | ||
Describe the behavior you expected instead of the crash. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: > | ||
Provide the Swift version, tag, or revision. If you suspect that the | ||
problem might be specific to a particular development platform or | ||
deployment target, please specify them as well. | ||
placeholder: $ swiftc -version | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional information | ||
description: > | ||
Any complementary information that could help others to work around | ||
the problem, and us to better understand the problem and its impact. | ||
For example, a link to a discussion or post that motivated this | ||
report. | ||
validations: | ||
required: false |
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,74 @@ | ||
# This source file is part of the Swift.org open source project | ||
# | ||
# Copyright (c) 2023 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 the list of Swift project authors | ||
|
||
name: 🌟 Request a change | ||
description: > | ||
Request a feature, improvement, or other change. | ||
labels: [feature, triage needed] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
This repository hosts the Swift compiler, the Swift standard library, | ||
the Swift runtime, SourceKit, and IDE support for the Swift language. | ||
It does *not* track feedback on Xcode and other closed source Apple | ||
developer software such as SwiftUI and UIKit; please direct it to | ||
[Feedback Assistant](https://developer.apple.com/bug-reporting) | ||
instead. | ||
|
||
___ | ||
|
||
|
||
Swift is guided by a community-driven process referred to as the | ||
[Swift evolution](https://www.swift.org/swift-evolution) | ||
process. Submitting this form is not a guarantee that the request will | ||
be considered or implemented. If the request implies an addition, | ||
removal, or change to the features of the Swift language or the public | ||
interface of the Swift standard library, please consider socializing it | ||
on the | ||
[Swift forums](https://forums.swift.org/c/evolution/discuss) | ||
instead. The Swift forums are the preferred space for sharing ideas and | ||
discussing them with the Swift community. | ||
- type: textarea | ||
attributes: | ||
label: Motivation | ||
description: > | ||
Describe the problems that this idea seeks to address. If the | ||
problem is that some common pattern is currently hard to express, show | ||
how one can currently get a similar effect and describe its drawbacks. | ||
If it's completely new functionality that cannot be emulated, motivate | ||
why this new functionality would help create better Swift code or | ||
developer tools. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Proposed solution | ||
description: > | ||
Describe the solution to the problem. Provide examples and describe how | ||
they work. Show how this solution is better than current workarounds: is | ||
it cleaner, safer, or more efficient? | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Alternatives considered | ||
description: > | ||
Any alternative approaches that were considered, and why the *proposed | ||
solution* was chosen instead. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Additional information | ||
description: > | ||
Any complementary information that could be valuable to an author of a | ||
formal proposal, an implementor, or future discussions. For example, a | ||
link to a discussion or post that motivated this request. | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
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.
Very interested to hear your thoughts on what order of contact links makes the most sense.
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.
Maybe "Ask" and "Report" links should be moved up and "Learn Swift" should be last?
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.
To the top, before "Discuss an idea" and "Formally propose a change"?