Skip to content

Commit f318cd4

Browse files
Add issue templates to docc-render (swiftlang#384)
* [r96950970] feat: add issue templates * Update .github/ISSUE_TEMPLATE/BUG_REPORT.yml Co-authored-by: Franklin Schrans <[email protected]> * [r96950970] chore: address feedback Co-authored-by: Franklin Schrans <[email protected]>
1 parent 2316910 commit f318cd4

File tree

3 files changed

+132
-0
lines changed

3 files changed

+132
-0
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for contributing to Swift-DocC-Render!
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.
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: |
15+
A short description of the incorrect behavior.
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.
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
attributes:
22+
label: Checklist
23+
options:
24+
- label: If possible, I've reproduced the issue using the `main` branch of this package.
25+
required: false
26+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/apple/swift-docc-render/issues).
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Expected Behavior
31+
description: Describe what you expected to happen.
32+
validations:
33+
required: false
34+
- type: textarea
35+
attributes:
36+
label: Actual behavior
37+
description: Describe or copy/paste the behavior you observe.
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Steps To Reproduce
43+
description: |
44+
Explanation of how to reproduce the incorrect behavior.
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.
47+
placeholder: |
48+
1. In this browser version...
49+
50+
2. With this viewport size...
51+
52+
3. See error/bug...
53+
validations:
54+
required: false
55+
- type: input
56+
attributes:
57+
label: Swift-DocC-Render Version Information
58+
description: The version of Swift-DocC-Render used to reproduce this issue.
59+
placeholder: "'0.1.0' for example, or a commit hash"
+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Feature Request
2+
description: A suggestion for a new feature
3+
labels: [New Feature]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for contributing to Swift-DocC-Render!
9+
10+
Before you submit your issue, please replace each text area below with information about your proposed feature.
11+
- type: input
12+
attributes:
13+
label: Feature Name
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Description
19+
description: |
20+
A description of your proposed feature.
21+
22+
Design proposals to 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.
23+
24+
How does it behave in different viewports?
25+
26+
Are there accessibility considerations for this feature?
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Motivation
32+
description: A description of the use-case this proposal is trying to serve.
33+
validations:
34+
required: false
35+
- type: textarea
36+
attributes:
37+
label: Importance
38+
description: |
39+
A description of the importance of this change.
40+
41+
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?
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Alternatives Considered
47+
description: If you considered alternative approaches for this feature, please include them here.
48+
validations:
49+
required: false

.github/ISSUE_TEMPLATE/config.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2022 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See https://swift.org/LICENSE.txt for license information
7+
# See https://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
# This is set to `false` to encourage users to use the provided templates instead
10+
# of beginning with a blank one.
11+
#
12+
# For details, see: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
13+
blank_issues_enabled: false
14+
15+
contact_links:
16+
- name: Discussion Forum
17+
url: https://forums.swift.org/c/development/swift-docc
18+
about: Ask and answer questions about Swift-DocC
19+
- name: Swift-DocC Documentation
20+
url: https://www.swift.org/documentation/docc/
21+
about: Learn about how to use the Swift-DocC documentation tool in your projects
22+
- name: Swift-DocC Technical Documentation
23+
url: https://apple.github.io/swift-docc/documentation/swiftdocc/
24+
about: Read Swift-DocC's technical API documentation

0 commit comments

Comments
 (0)