Skip to content

Commit b89ab84

Browse files
Merge pull request #61993 from AnthonyLatsis/gh-templates
[github] Misc improvements to issue templates
2 parents 942490d + 5779045 commit b89ab84

File tree

2 files changed

+73
-30
lines changed

2 files changed

+73
-30
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,39 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
12-
13-
**Steps To Reproduce**
14-
Steps to reproduce the behavior:
15-
1.
16-
2.
17-
...
10+
<!--
11+
This repository tracks issues related to the implementation of the Swift
12+
compiler, standard library, runtime, and tools that provide IDE support for
13+
Swift (e.g. code completion). If the bug relates to the implementation of a
14+
proprietary (closed-source) Apple framework such as UIKit, SwiftUI, Combine,
15+
etc., please report it to https://feedbackassistant.apple.com instead.
16+
-->
17+
18+
**Description**
19+
<!-- Describe clearly and concisely what the bug is. -->
20+
21+
**Steps to reproduce**
22+
<!--
23+
Explain how to reproduce the problem (in steps if seen fit) and include either
24+
an inline test case (preferred) or a project that reproduces it. Consider
25+
reducing the sample to the smallest amount of code possible — a smaller test
26+
case is easier to reason about and more appealing to сontributors.
27+
-->
1828

1929
**Expected behavior**
20-
A clear and concise description of what you expected to happen.
21-
22-
**Screenshots**
23-
If applicable, add screenshots to help explain your problem.
24-
25-
**Environment (please fill out the following information)**
26-
- OS: [e.g. macOS 11.0]
27-
- Xcode Version/Tag/Branch:
28-
29-
30-
**Additional context**
31-
Add any other context about the problem here.
30+
<!-- Describe what you expected to happen. -->
31+
32+
<!-- If deemed helpful, add screenshots that showcase the problem. -->
33+
<!-- **Screenshots** -->
34+
35+
<!--
36+
Include information about the Swift compiler version and, if applicable, the
37+
Xcode version you are observing the problem in and the deployment target.
38+
-->
39+
**Environment**
40+
- Swift compiler version info <!-- replace with the output of 'swiftc -version' -->
41+
- Xcode version info <!-- replace with the output of 'xcodebuild -version' -->
42+
- Deployment target: <!-- e.g. iOS 12.3 -->
43+
44+
<!-- Add any other context about the problem as appropriate. -->
45+
<!-- **Additional context** -->
Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,49 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Share an idea
44
title: ''
5-
labels: New Feature
5+
labels: feature request
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
<!--
11+
This repository tracks issues and requests related to the implementation of the
12+
Swift compiler, standard library, runtime, and tools that provide IDE support
13+
for Swift (e.g. code completion). If your feature request relates to the
14+
implementation of a proprietary (closed-source) Apple framework such as UIKit,
15+
SwiftUI, Combine, etc., please report it to https://feedbackassistant.apple.com
16+
instead.
1217
13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
18+
If you haven't found or started a thread on the Swift forums yet, consider
19+
socializing your idea in the "Discussion" subcategory
20+
(https://forums.swift.org/c/evolution/discuss) after submitting this request.
21+
This is an essential step toward the official review of any proposal concerning
22+
language or library design, and while GitHub issues do great for tracking
23+
purposes, the forums are far better ground for drawing attention to ideas and
24+
gauging interest from the community.
1525
16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
26+
For more information on how ideas are proposed, discussed, and reviewed, see
27+
https://swift.org/swift-evolution
28+
-->
1829

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
30+
**Motivation**
31+
<!-- Describe the problem that your feature seeks to address. -->
32+
33+
**Solution**
34+
<!--
35+
Describe your solution to the problem. Provide examples and describe how
36+
they work.
37+
-->
38+
39+
**Alternatives considered**
40+
<!--
41+
Describe any alternative approaches or features that you have considered in
42+
addressing the problem, and why you chose this approach instead.
43+
-->
44+
45+
<!--
46+
Add any other context about your feature as appropriate. For example, link out
47+
to a discussion on the Swift forums (https://forums.swift.org).
48+
-->
49+
<!-- **Additional context** -->

0 commit comments

Comments
 (0)