Skip to content

Commit e4b90e5

Browse files
authored
Better GitHub issue templates (#1683)
* Better GitHub issue templates The [babel](https://github.com/babel/babel/issues/new/choose) project had a pretty neat idea for GitHub issue templates, so I'd like to adapt them for the Node.js website. As we receive issues for API docs (which are not hosted here) and other, it might be a good idea to guide the user to the right place directly. * Fix typos
1 parent 75d3ba8 commit e4b90e5

File tree

6 files changed

+65
-20
lines changed

6 files changed

+65
-20
lines changed

.github/ISSUE_TEMPLATE.md

100644100755
Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,6 @@
1-
<!--
2-
Thanks for wanting to report an issue you've found on the nodejs.org website.
1+
<!---
2+
Thanks for filing an issue 😄! Before you submit, please read the following:
33
4-
For issues regarding the Node.js API docs, please head over to:
5-
https://github.com/nodejs/node/issues/ (prefix your issue name with "doc")
6-
7-
For general questions about Node.js:
8-
https://github.com/nodejs/help/issues/
9-
10-
Please fill in the template below by replacing the HTML comments with an
11-
appropriate answer. If unsure about something, just do as best as you're able.
12-
If you are reporting a visual glitch, it will be much easier for us to fix it
13-
when you attach a screenshot as well.
14-
15-
Thank you!
4+
Check the other issue templates if you are trying to submit a bug report, feature request, or question.
5+
Search open/closed issues before submitting since someone might have asked the same thing before!
166
-->
17-
18-
* **URL**:
19-
* **Browser version**:
20-
* **Operating system**:
21-
22-
<!-- Enter your issue details below this comment. -->

.github/ISSUE_TEMPLATE/api_docs.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
---
3+
name: 📗 Node.js API Docs
4+
about: Please open an issue in the main [Node.js repo](https://github.com/nodejs/node/issues/), prefixed with "doc".
5+
6+
---
7+
<!--
8+
For issues regarding the Node.js API docs, please head over to:
9+
https://github.com/nodejs/node/issues/ (prefix your issue name with "doc").
10+
-->

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: If something isn't working as expected 🤔.
4+
5+
---
6+
<!--
7+
Thanks for wanting to report an issue you've found on the nodejs.org website.
8+
9+
Please fill in the template below. If unsure about something, just do as best
10+
as you're able. If you are reporting a visual glitch, it will be much easier
11+
for us to fix it when you attach a screenshot as well.
12+
-->
13+
14+
* **URL**:
15+
* **Browser version**:
16+
* **Operating system**:
17+
18+
<!-- Enter your issue details below this comment. -->
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: I have a suggestion (and may want to implement it 🙂)!
4+
5+
---
6+
<!--
7+
You have an idea how to improve the site? That's awesome!
8+
9+
Before submitting, please have a look at the existing issues if there's already
10+
something related to your suggestion.
11+
12+
We are also working on a relaunch at the moment, so it might be a good idea to
13+
check out our plans there as well: https://github.com/nodejs/website-redesign/issues/
14+
15+
Help is always welcome!
16+
-->

.github/ISSUE_TEMPLATE/help.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: ⁉️ General Questions
3+
about: Need help with Node.js? File an Issue [here](https://github.com/nodejs/help/issues/).
4+
5+
---
6+
<!--
7+
We have a special help section for general questions about Node.js:
8+
https://github.com/nodejs/help/issues/
9+
-->

.github/ISSUE_TEMPLATE/i18n.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: 🔡 Internationalization and translations
3+
about: Hello. Hola. Salut. Ciao. Здравствуйте. こんにちは.
4+
5+
---
6+
<!--
7+
Please mention the relevant localization team in your issue, it helps us having the right people take a look, e.g. `@nodejs/node-cn` for Chinese translations.
8+
-->

0 commit comments

Comments
 (0)