Skip to content

Commit 07f7d52

Browse files
authored
Rewrite issue template to a HTML comment
1 parent 0ceeb49 commit 07f7d52

1 file changed

Lines changed: 20 additions & 17 deletions

File tree

.github/issue_template.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
## General Information
1+
<!--
2+
Hi, thanks so much for opening an issue! 🤗
23
3-
* MessageKit Version:
4+
To better pinpoint (and solve) the issue you're experiencing, we could use some information on your behalf.
45
5-
* iOS Version(s):
6+
Please let us know the following things:
67
7-
* Swift Version:
8-
9-
* Devices/Simulators:
10-
11-
* Reproducible in ChatExample? (Yes/No):
12-
13-
14-
15-
## What happened?
16-
17-
18-
19-
20-
## What did you expect to happen?
8+
- What version of MessageKit are you using?
9+
- What version of iOS are you running on?
10+
- What version of Swift are you running on?
11+
- What device(s) are you testing on? Are these simulators?
12+
- Is the issue you're experiencing reproducable in the example app?
2113
14+
In some cases it can be really helpful to provide a short example of your code.
15+
If so, please wrap these code blocks in backticks, like this:
2216
17+
```swift
18+
*your code goes here*
19+
```
2320
21+
The code will automatically get its syntax highlighted, and doesn't need to be indented 4 spaces to be shown as code.
2422
23+
When referencing a dependency manager-related issue (think CocoaPods, Carthage, SwiftPM), please add its configuration file and version to the issue.
24+
It would be helpful to put the contents in a code block too, using ```ruby for CocoaPods and ```swift for SwiftPM.
2525
26+
Also please make sure your title describes your problem well. Questions end with a question mark.
2627
28+
Thanks again, and let us know if there are any other questions you might have.
29+
-->

0 commit comments

Comments
 (0)