Skip to content

Commit 8afe743

Browse files
Update for Github Issues Migration (#18)
* Update feature request and bug report sections Co-authored-by: Ethan Kusters <[email protected]>
1 parent caea386 commit 8afe743

File tree

4 files changed

+113
-2
lines changed

4 files changed

+113
-2
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug Report
3+
about: Something isn't working as expected
4+
labels: bug
5+
---
6+
7+
<!--
8+
Thank you for contributing to the Swift-DocC plugin!
9+
10+
Before you submit your issue, please replace each paragraph
11+
below with the relevant details for your bug, and complete
12+
the steps in the checklist by placing an 'x' in each box:
13+
14+
- [x] I've completed this task
15+
- [ ] This task isn't completed
16+
-->
17+
18+
Replace this paragraph with 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+
23+
### Checklist
24+
- [ ] If possible, I've reproduced the issue using the `main` branch of this package.
25+
- [ ] This issue hasn't been addressed in an [existing GitHub issue](https://github.com/apple/swift-docc-plugin/issues).
26+
27+
### Expected behavior
28+
Describe what you expected to happen.
29+
30+
### Actual behavior
31+
Describe or copy/paste the behavior you observe.
32+
33+
### Steps to Reproduce
34+
Replace this paragraph with an explanation of how to reproduce the incorrect behavior.
35+
This could include a reduced version of your documentation bundle,
36+
or a link to the documentation (or code) that is exhibiting the issue.
37+
38+
### Swift-DocC Plugin Version Information
39+
40+
**Swift-DocC plugin version:** `1.0.0` for example, or a commit hash.
41+
**Swift Compiler version:** Output from `swiftc --version`.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Feature Request
3+
about: A suggestion for a new feature
4+
labels: enhancement
5+
---
6+
7+
<!--
8+
Thank you for contributing to the Swift-DocC plugin!
9+
10+
Before you submit your issue, please replace each paragraph
11+
below with information about your proposed feature.
12+
-->
13+
14+
### Feature Request: _<Feature Name>_
15+
16+
#### Description:
17+
18+
Replace this paragraph with a description of your proposed feature.
19+
Sample documentation catalogs that show what's missing,
20+
or what new capabilities will be possible, are very helpful!
21+
Provide links to existing issues or external references/discussions, if appropriate.
22+
23+
#### Motivation:
24+
25+
Replace this paragraph with a description of the use-case this proposal is trying to serve.
26+
27+
#### Importance:
28+
29+
Replace this paragraph with a description of the importance of this change.
30+
Does this feature unlock entirely new use-cases?
31+
Or is it possible to achieve the same functionality with existing functionality
32+
and this change would improve the user experience?
33+
34+
#### Alternatives Considered
35+
36+
If you considered alternative approaches for this feature, please include them here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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: Documentation
20+
url: https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/
21+
about: Read about how to use the Swift-DocC Plugin in your projects

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,23 @@ For details on how to best build documentation for hosting online and a specific
8686
tutorial for publishing to GitHub Pages, please see
8787
[the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/).
8888

89+
## Bug Reports and Feature Requests
90+
91+
### Submitting a Bug Report
92+
93+
The Swift-DocC plugin tracks all bug reports with
94+
[GitHub Issues](https://github.com/apple/swift-docc-plugin/issues).
95+
When you submit a bug report we ask that you follow the
96+
[provided template](https://github.com/apple/swift-docc-plugin/issues/new?template=BUG_REPORT.md)
97+
and provide as many details as possible.
98+
99+
If you can confirm that the bug occurs when using the latest commit of the Swift-DocC plugin
100+
from the `main` branch, that will help us track down the bug faster.
101+
89102
### Submitting a Feature Request
90103

91-
For feature requests, please feel free to create an issue
92-
on [Swift JIRA](https://bugs.swift.org/) with the `New Feature` type
104+
For feature requests, please feel free to file a
105+
[GitHub issue](https://github.com/apple/swift-docc-plugin/issues/new?template=FEATURE_REQUEST.md)
93106
or start a discussion on the [Swift Forums](https://forums.swift.org/c/development/swift-docc).
94107

95108
Don't hesitate to submit a feature request if you see a way

0 commit comments

Comments
 (0)