Skip to content

Commit 5e6db7a

Browse files
committed
[github] Misc improvements to issue templates
* Reword and comment out placeholder text. * Use the `language feature request` label for the feature request template; `new feature` is somewhat ambiguous and needs to be replaced. * Add hints for obtaining exhaustive information about the compiler/Xcode version.
1 parent cb4ed70 commit 5e6db7a

File tree

2 files changed

+37
-25
lines changed

2 files changed

+37
-25
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,31 @@ proprietary (closed-source) Apple framework such as UIKit, SwiftUI, Combine,
1515
etc., please report it to https://feedbackassistant.apple.com instead.
1616
-->
1717

18-
**Describe the bug**
19-
A clear and concise description of what the bug is.
18+
**Description**
19+
<!-- Describe clearly and concisely what the bug is. -->
2020

21-
**Steps To Reproduce**
22-
Steps to reproduce the behavior:
23-
1.
24-
2.
25-
...
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+
-->
2628

2729
**Expected behavior**
28-
A clear and concise description of what you expected to happen.
29-
30-
**Screenshots**
31-
If applicable, add screenshots to help explain your problem.
30+
<!-- Describe what you expected to happen. -->
3231

33-
**Environment (please fill out the following information)**
34-
- OS: [e.g. macOS 11.0]
35-
- Xcode Version/Tag/Branch:
32+
<!-- If deemed helpful, add screenshots that showcase the problem. -->
33+
<!-- **Screenshots** -->
3634

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 -->
3743

38-
**Additional context**
39-
Add any other context about the problem here.
44+
<!-- Add any other context about the problem as appropriate. -->
45+
<!-- **Additional context** -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: New Feature
5+
labels: feature request
66
assignees: ''
77

88
---
@@ -16,14 +16,20 @@ SwiftUI, Combine, etc., please report it to https://feedbackassistant.apple.com
1616
instead.
1717
-->
1818

19-
**Is your feature request related to a problem? Please describe.**
20-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
19+
**Motivation**
20+
<!-- Describe the problem that your feature seeks to address. -->
2121

22-
**Describe the solution you'd like**
23-
A clear and concise description of what you want to happen.
22+
**Solution**
23+
<!--
24+
Describe your solution to the problem. Provide examples and describe how
25+
they work.
26+
-->
2427

25-
**Describe alternatives you've considered**
26-
A clear and concise description of any alternative solutions or features you've considered.
28+
**Alternatives considered**
29+
<!--
30+
Describe any alternative approaches or features that you have considered in
31+
addressing the problem, and why you chose this approach instead.
32+
-->
2733

28-
**Additional context**
29-
Add any other context or screenshots about the feature request here.
34+
<!-- Add any other context about your feature as appropriate. -->
35+
<!-- **Additional context** -->

0 commit comments

Comments
 (0)