Skip to content

Commit ed1770f

Browse files
committed
Fix code review suggestion
1 parent 9887d2c commit ed1770f

File tree

2 files changed

+26
-36
lines changed

2 files changed

+26
-36
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@ name: Bug Report
22
description: Something isn't working as expected
33
labels: [bug]
44
body:
5-
- type: markdown
6-
attributes:
7-
value: "## Thank you for contributing to Swift-DocC!"
85
- type: markdown
96
attributes:
107
value: |
11-
Before you submit your issue, please complete each textarea
12-
below with the relevant details for your bug, and complete
13-
the steps in the checklist
8+
Thank you for contributing to Swift-DocC!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
1411
- type: textarea
1512
attributes:
1613
label: Description
1714
description: |
1815
A short description of the incorrect behavior.
19-
If you think this issue has been recently introduced and did not occur in an
20-
earlier version, please note that. If possible, include the last version that
21-
the behavior was correct in addition to your current version.
16+
17+
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
2218
validations:
2319
required: true
2420
- type: checkboxes
@@ -46,25 +42,26 @@ body:
4642
label: Steps To Reproduce
4743
description: |
4844
Explanation of how to reproduce the incorrect behavior.
49-
This could include a reduced version of your documentation bundle,
50-
or a link to the documentation (or code) that is exhibiting the issue.
45+
46+
This could include a reduced version of your documentation bundle, or a link to the documentation (or code) that is exhibiting the issue.
5147
placeholder: |
5248
1. In this environment...
49+
5350
2. With this config...
51+
5452
3. Run '...'
53+
5554
4. See error...
5655
validations:
5756
required: false
58-
- type: textarea
57+
- type: input
5958
attributes:
6059
label: Swift-DocC Version Information
61-
description: |
62-
examples:
63-
- **Swift-DocC version:** `5.6.0` for example, or a commit hash.
64-
- **Swift Compiler version:** Output from `swiftc --version`.
65-
value: |
66-
- Swift-DocC version:
67-
- Swift Compiler version:
68-
render: markdown
69-
validations:
70-
required: false
60+
description: The version of Swift-DocC used to reproduce this issue.
61+
placeholder: "'5.6.0' for example, or a commit hash"
62+
- type: textarea
63+
attributes:
64+
label: Swift Compiler Version Information
65+
description: The version of Swift used to reproduce this issue.
66+
placeholder: Output from 'swiftc --version'
67+
render: shell

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,12 @@ name: Feature Request
22
description: A suggestion for a new feature
33
labels: [enhancement]
44
body:
5-
- type: markdown
6-
attributes:
7-
value: "## Thank you for contributing to Swift-DocC!"
85
- type: markdown
96
attributes:
107
value: |
11-
Before you submit your issue, please replace each textarea
12-
below with information about your proposed feature.
13-
- type: markdown
14-
attributes:
15-
value: "## Feature Request"
8+
Thank you for contributing to Swift-DocC!
9+
10+
Before you submit your issue, please replace each text area below with information about your proposed feature.
1611
- type: input
1712
attributes:
1813
label: Feature Name
@@ -23,9 +18,8 @@ body:
2318
label: Description
2419
description: |
2520
A description of your proposed feature.
26-
Sample documentation catalogs that show what's missing,
27-
or what new capabilities will be possible, are very helpful!
28-
Provide links to existing issues or external references/discussions, if appropriate.
21+
22+
Sample documentation catalogs that show what's missing, or what new capabilities will be possible, are very helpful! Provide links to existing issues or external references/discussions, if appropriate.
2923
validations:
3024
required: true
3125
- type: textarea
@@ -39,9 +33,8 @@ body:
3933
label: Importance
4034
description: |
4135
A description of the importance of this change.
42-
Does this feature unlock entirely new use-cases?
43-
Or is it possible to achieve the same functionality with existing functionality
44-
and this change would improve the user experience?
36+
37+
Does this feature unlock entirely new use-cases? Or is it possible to achieve the same functionality with existing functionality and this change would improve the user experience?
4538
validations:
4639
required: false
4740
- type: textarea

0 commit comments

Comments
 (0)