Skip to content

Commit 9887d2c

Browse files
committed
Adopt new GitHub Issues Forms syntax
1 parent 8156ed0 commit 9887d2c

File tree

4 files changed

+122
-77
lines changed

4 files changed

+122
-77
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

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

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: "## Thank you for contributing to Swift-DocC!"
8+
- type: markdown
9+
attributes:
10+
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
14+
- type: textarea
15+
attributes:
16+
label: Description
17+
description: |
18+
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.
22+
validations:
23+
required: true
24+
- type: checkboxes
25+
attributes:
26+
label: Checklist
27+
options:
28+
- label: If possible, I've reproduced the issue using the `main` branch of this package.
29+
required: false
30+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/apple/swift-docc/issues).
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Expected Behavior
35+
description: Describe what you expected to happen.
36+
validations:
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Actual behavior
41+
description: Describe or copy/paste the behavior you observe.
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Steps To Reproduce
47+
description: |
48+
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.
51+
placeholder: |
52+
1. In this environment...
53+
2. With this config...
54+
3. Run '...'
55+
4. See error...
56+
validations:
57+
required: false
58+
- type: textarea
59+
attributes:
60+
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

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Feature Request
2+
description: A suggestion for a new feature
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: "## Thank you for contributing to Swift-DocC!"
8+
- type: markdown
9+
attributes:
10+
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"
16+
- type: input
17+
attributes:
18+
label: Feature Name
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Description
24+
description: |
25+
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.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Motivation
34+
description: A description of the use-case this proposal is trying to serve.
35+
validations:
36+
required: false
37+
- type: textarea
38+
attributes:
39+
label: Importance
40+
description: |
41+
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?
45+
validations:
46+
required: false
47+
- type: textarea
48+
attributes:
49+
label: Alternatives Considered
50+
description: If you considered alternative approaches for this feature, please include them here.
51+
validations:
52+
required: false

0 commit comments

Comments
 (0)