Skip to content

Commit

Permalink
Better GitHub issue templates (#1683)
Browse files Browse the repository at this point in the history
* 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
fhemberger authored Jun 9, 2018

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 75d3ba8 commit e4b90e5
Showing 6 changed files with 65 additions and 20 deletions.
24 changes: 4 additions & 20 deletions .github/ISSUE_TEMPLATE.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,22 +1,6 @@
<!--
Thanks for wanting to report an issue you've found on the nodejs.org website.
<!---
Thanks for filing an issue 😄! Before you submit, please read the following:
For issues regarding the Node.js API docs, please head over to:
https://github.com/nodejs/node/issues/ (prefix your issue name with "doc")
For general questions about Node.js:
https://github.com/nodejs/help/issues/
Please fill in the template below by replacing the HTML comments with an
appropriate answer. If unsure about something, just do as best as you're able.
If you are reporting a visual glitch, it will be much easier for us to fix it
when you attach a screenshot as well.
Thank you!
Check the other issue templates if you are trying to submit a bug report, feature request, or question.
Search open/closed issues before submitting since someone might have asked the same thing before!
-->

* **URL**:
* **Browser version**:
* **Operating system**:

<!-- Enter your issue details below this comment. -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/api_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

---
name: 📗 Node.js API Docs
about: Please open an issue in the main [Node.js repo](https://github.com/nodejs/node/issues/), prefixed with "doc".

---
<!--
For issues regarding the Node.js API docs, please head over to:
https://github.com/nodejs/node/issues/ (prefix your issue name with "doc").
-->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected 🤔.

---
<!--
Thanks for wanting to report an issue you've found on the nodejs.org website.
Please fill in the template below. If unsure about something, just do as best
as you're able. If you are reporting a visual glitch, it will be much easier
for us to fix it when you attach a screenshot as well.
-->

* **URL**:
* **Browser version**:
* **Operating system**:

<!-- Enter your issue details below this comment. -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: 🚀 Feature Request
about: I have a suggestion (and may want to implement it 🙂)!

---
<!--
You have an idea how to improve the site? That's awesome!
Before submitting, please have a look at the existing issues if there's already
something related to your suggestion.
We are also working on a relaunch at the moment, so it might be a good idea to
check out our plans there as well: https://github.com/nodejs/website-redesign/issues/
Help is always welcome!
-->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: ⁉️ General Questions
about: Need help with Node.js? File an Issue [here](https://github.com/nodejs/help/issues/).

---
<!--
We have a special help section for general questions about Node.js:
https://github.com/nodejs/help/issues/
-->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/i18n.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: 🔡 Internationalization and translations
about: Hello. Hola. Salut. Ciao. Здравствуйте. こんにちは.

---
<!--
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.
-->

0 comments on commit e4b90e5

Please sign in to comment.