You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/BUG_REPORT.yml
+19-22Lines changed: 19 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,19 @@ name: Bug Report
2
2
description: Something isn't working as expected
3
3
labels: [bug]
4
4
body:
5
-
- type: markdown
6
-
attributes:
7
-
value: "## Thank you for contributing to Swift-DocC!"
8
5
- type: markdown
9
6
attributes:
10
7
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
14
11
- type: textarea
15
12
attributes:
16
13
label: Description
17
14
description: |
18
15
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.
22
18
validations:
23
19
required: true
24
20
- type: checkboxes
@@ -46,25 +42,26 @@ body:
46
42
label: Steps To Reproduce
47
43
description: |
48
44
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.
51
47
placeholder: |
52
48
1. In this environment...
49
+
53
50
2. With this config...
51
+
54
52
3. Run '...'
53
+
55
54
4. See error...
56
55
validations:
57
56
required: false
58
-
- type: textarea
57
+
- type: input
59
58
attributes:
60
59
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.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
+7-14Lines changed: 7 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,12 @@ name: Feature Request
2
2
description: A suggestion for a new feature
3
3
labels: [enhancement]
4
4
body:
5
-
- type: markdown
6
-
attributes:
7
-
value: "## Thank you for contributing to Swift-DocC!"
8
5
- type: markdown
9
6
attributes:
10
7
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.
16
11
- type: input
17
12
attributes:
18
13
label: Feature Name
@@ -23,9 +18,8 @@ body:
23
18
label: Description
24
19
description: |
25
20
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.
29
23
validations:
30
24
required: true
31
25
- type: textarea
@@ -39,9 +33,8 @@ body:
39
33
label: Importance
40
34
description: |
41
35
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?
0 commit comments