Skip to content

Commit 0c3964b

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

File tree

4 files changed

+147
-94
lines changed

4 files changed

+147
-94
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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 feedback on Xcode and other closed-source Apple
20+
software such as SwiftUI and UIKit; please direct it to
21+
[Feedback Assistant](https://developer.apple.com/bug-reporting)
22+
instead.
23+
- type: textarea
24+
attributes:
25+
label: Description
26+
description: >
27+
A concise description of what causes the problem, in human language.
28+
Though not required, it may help us to more accurately triage the issue
29+
as well as understand a non-trivial test case.
30+
validations:
31+
required: false
32+
- type: textarea
33+
attributes:
34+
label: Reproduction
35+
description: >
36+
Provide a test case, preferably in a Markdown codeblock, and explain
37+
how to build or run it to reproduce the problem. If the problem is a
38+
poor or unexpected error, warning, fix-it, or output, please show
39+
them. Consider reducing the test case to the smallest amount of code
40+
possible — a smaller test case is easier to reason about and more
41+
appealing to contributors.
42+
value: |
43+
```swift
44+
45+
```
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Expected behavior
51+
description: Describe the behavior you expected.
52+
validations:
53+
required: true
54+
- type: textarea
55+
attributes:
56+
label: Environment
57+
description: >
58+
Provide the Swift version, tag, or revision. If you suspect that the
59+
problem might be specific to a particular development platform or
60+
deployment target, please specify them as well.
61+
placeholder: $ swiftc -version
62+
validations:
63+
required: true
64+
- type: textarea
65+
attributes:
66+
label: Additional information
67+
description: >
68+
Any complementary information that could help others to work around
69+
the problem, and us to better understand the problem and its impact.
70+
For example, a link to a discussion or post that motivated this
71+
report.
72+
validations:
73+
required: false

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/feature_request.md

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

0 commit comments

Comments
 (0)