Skip to content

Commit 8ff767b

Browse files
committed
.github: Migrate Markdown issue templates to YAML forms
1 parent 140caf6 commit 8ff767b

File tree

4 files changed

+149
-94
lines changed

4 files changed

+149
-94
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2023 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 the list of Swift project authors
8+
9+
name: 🪲 Report a bug
10+
description: >
11+
Report a deviation from expected or documented behavior, but not a crash.
12+
labels: [bug, triage needed]
13+
body:
14+
- type: markdown
15+
attributes:
16+
value: >
17+
This repository hosts the Swift compiler, the Swift standard library,
18+
the Swift runtime, SourceKit, and IDE support for the Swift language.
19+
It does *not* track issues with or requests for Xcode and other
20+
closed-source Apple software such as SwiftUI and UIKit; please direct
21+
them to
22+
[feedbackassistant.apple.com](https://feedbackassistant.apple.com)
23+
instead.
24+
- type: textarea
25+
attributes:
26+
label: Description
27+
description: >
28+
A concise description of what causes the problem, in human language.
29+
Though not required, it may help us to more accurately triage the issue
30+
as well as understand a non-trivial test case.
31+
validations:
32+
required: false
33+
- type: textarea
34+
attributes:
35+
label: Reproduction
36+
description: >
37+
Provide a test case, preferably in a Markdown codeblock, and explain
38+
how to build or run it to reproduce the problem. If the problem is a
39+
poor or unexpected error, warning, fix-it, or output, please show
40+
them. Consider reducing the test case to the smallest amount of code
41+
possible — a smaller test case is easier to reason about and more
42+
appealing to contributors.
43+
value: |
44+
```swift
45+
46+
```
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Expected behavior
52+
description: Describe the behavior you expected.
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: Environment
58+
description: >
59+
Provide the Swift version, tag, or revision. If you suspect that the
60+
problem might be specific to a particular development platform or
61+
deployment target, please specify them as well.
62+
placeholder: $ swiftc -version
63+
validations:
64+
required: true
65+
- type: textarea
66+
attributes:
67+
label: Additional information
68+
description: >
69+
Any complementary information that could help others to work around
70+
the problem, and us to better understand the problem and its impact.
71+
For example, a link to a discussion or post that motivated this
72+
report.
73+
validations:
74+
required: false

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 45 deletions
This file was deleted.
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2023 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 the list of Swift project authors
8+
9+
name: 🌟 Request a change
10+
description: >
11+
Request a feature, improvement, or other change.
12+
labels: [feature, triage needed]
13+
body:
14+
- type: markdown
15+
attributes:
16+
value: >
17+
This repository hosts the Swift compiler, the Swift standard library,
18+
the Swift runtime, SourceKit, and IDE support for the Swift language.
19+
It does *not* track issues with or requests for Xcode and other
20+
closed-source Apple software such as SwiftUI and UIKit; please direct
21+
them to
22+
[feedbackassistant.apple.com](https://feedbackassistant.apple.com)
23+
instead.
24+
25+
___
26+
27+
28+
Swift is guided by a community-driven process referred to as the
29+
[Swift evolution](https://www.swift.org/swift-evolution)
30+
process. Submitting this form is not a guarantee that the request will
31+
be considered or implemented. If the request implies an addition,
32+
removal, or change to the features of the Swift language or the public
33+
interface of the Swift standard library, please consider socializing it
34+
on the
35+
[Swift forums](https://forums.swift.org/c/evolution/discuss)
36+
instead. The Swift forums are the preferred space for sharing ideas and
37+
discussing them with the Swift community.
38+
- type: textarea
39+
attributes:
40+
label: Motivation
41+
description: >
42+
Describe the problems that this idea seeks to address. If the
43+
problem is that some common pattern is currently hard to express, show
44+
how one can currently get a similar effect and describe its drawbacks.
45+
If it's completely new functionality that cannot be emulated, motivate
46+
why this new functionality would help create better Swift code or
47+
developer tools.
48+
validations:
49+
required: true
50+
- type: textarea
51+
attributes:
52+
label: Proposed solution
53+
description: >
54+
Describe the solution to the problem. Provide examples and describe how
55+
they work. Show how this solution is better than current workarounds: is
56+
it cleaner, safer, or more efficient?
57+
validations:
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: Alternatives considered
62+
description: >
63+
Any alternative approaches that were considered, and why the *proposed
64+
solution* was chosen instead.
65+
validations:
66+
required: false
67+
- type: textarea
68+
attributes:
69+
label: Additional information
70+
description: >
71+
Any complementary information that could be valuable to an author of a
72+
formal proposal, an implementor, or future discussions. For example, a
73+
link to a discussion or post that motivated this request.
74+
validations:
75+
required: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)