From 2978f76393ada18fac23e410bcb219b02cc00c60 Mon Sep 17 00:00:00 2001 From: Frederic Hemberger Date: Sat, 9 Jun 2018 14:55:59 +0200 Subject: [PATCH 1/2] 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. --- .github/ISSUE_TEMPLATE.md | 24 ++++------------------- .github/ISSUE_TEMPLATE/api_docs.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 18 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 15 ++++++++++++++ .github/ISSUE_TEMPLATE/help.md | 9 +++++++++ .github/ISSUE_TEMPLATE/i18n.md | 8 ++++++++ 6 files changed, 64 insertions(+), 20 deletions(-) mode change 100644 => 100755 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/api_docs.md create mode 100755 .github/ISSUE_TEMPLATE/bug_report.md create mode 100755 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/help.md create mode 100644 .github/ISSUE_TEMPLATE/i18n.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md old mode 100644 new mode 100755 index 249979ae08105..b03dc81ad08c9 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,22 +1,6 @@ - - -* **URL**: -* **Browser version**: -* **Operating system**: - - diff --git a/.github/ISSUE_TEMPLATE/api_docs.md b/.github/ISSUE_TEMPLATE/api_docs.md new file mode 100644 index 0000000000000..58c96e6922bb2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/api_docs.md @@ -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". + +--- + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100755 index 0000000000000..a902e02e10b7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,18 @@ +--- +name: πŸ› Bug Report +about: If something isn't working as expected πŸ€”. + +--- + + +* **URL**: +* **Browser version**: +* **Operating system**: + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100755 index 0000000000000..f996bdbfda2b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,15 @@ +--- +name: πŸš€ Feature Request +about: I have a suggestion (and may want to implement it πŸ™‚)! + +--- + diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md new file mode 100644 index 0000000000000..9420a6b08b266 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help.md @@ -0,0 +1,9 @@ +--- +name: ⁉️ General Questions +about: Need help with Node.js? File an Issue [here](https://github.com/nodejs/help/issues/). + +--- + diff --git a/.github/ISSUE_TEMPLATE/i18n.md b/.github/ISSUE_TEMPLATE/i18n.md new file mode 100644 index 0000000000000..e07e202a4bbd4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/i18n.md @@ -0,0 +1,8 @@ +--- +name: πŸ”‘ Internationalization and translations +about: Hello. Hola. Salut. Ciao. ЗдравствуйтС. こんにけは. + +--- + From 7469ba40e6d54bb245fc726be9af1b53cc5e5ae9 Mon Sep 17 00:00:00 2001 From: Frederic Hemberger Date: Sat, 9 Jun 2018 17:06:25 +0200 Subject: [PATCH 2/2] Fix typos --- .github/ISSUE_TEMPLATE.md | 2 +- .github/ISSUE_TEMPLATE/api_docs.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 5 +++-- .github/ISSUE_TEMPLATE/help.md | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b03dc81ad08c9..5655c2f19845e 100755 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ diff --git a/.github/ISSUE_TEMPLATE/api_docs.md b/.github/ISSUE_TEMPLATE/api_docs.md index 58c96e6922bb2..0809cb198a10f 100644 --- a/.github/ISSUE_TEMPLATE/api_docs.md +++ b/.github/ISSUE_TEMPLATE/api_docs.md @@ -6,5 +6,5 @@ about: Please open an issue in the main [Node.js repo](https://github.com/nodejs --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f996bdbfda2b9..d4a7cbd603108 100755 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,7 +9,8 @@ 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](https://github.com/nodejs/website-redesign/issues/) -at the moment, so it might be a good idea to check out our plans there as well. +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! --> diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md index 9420a6b08b266..a92cfcff99f29 100644 --- a/.github/ISSUE_TEMPLATE/help.md +++ b/.github/ISSUE_TEMPLATE/help.md @@ -4,6 +4,6 @@ about: Need help with Node.js? File an Issue [here](https://github.com/nodejs/he ---