Skip to content

Commit fffa0a3

Browse files
chore: update GitHub issue templates
1 parent cec2750 commit fffa0a3

File tree

4 files changed

+91
-25
lines changed

4 files changed

+91
-25
lines changed

.github/ISSUE_TEMPLATE.md

-25
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
15+
Please fill the following code example:
16+
17+
Engine.IO server version: `x.y.z`
18+
19+
*Server*
20+
21+
```js
22+
const engine = require("engine.io");
23+
const server = engine.listen(3000, {});
24+
25+
server.on("connection", (socket) => {
26+
console.log("connection");
27+
28+
socket.on("message", (data) => {
29+
console.log("data", data);
30+
});
31+
32+
socket.on("close", () => {
33+
console.log("close");
34+
});
35+
});
36+
```
37+
38+
Engine.IO client version: `x.y.z`
39+
40+
*Client*
41+
42+
```js
43+
const socket = require("engine.io-client")("ws://localhost:3000");
44+
45+
socket.on("open", () => {
46+
console.log("open");
47+
48+
socket.on("message", (data) => {
49+
console.log("data", data);
50+
});
51+
52+
socket.on("close", () => {
53+
console.log("close");
54+
});
55+
});
56+
```
57+
58+
**Expected behavior**
59+
A clear and concise description of what you expected to happen.
60+
61+
**Platform:**
62+
- Device: [e.g. Samsung S8]
63+
- OS: [e.g. Android 9.2]
64+
65+
**Additional context**
66+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a Question
4+
url: https://github.com/socketio/socket.io/discussions/new?category=q-a
5+
about: Ask the community for help
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)