meta: make issue template mobile friendly and address nits

PR-URL: #34243 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Anto Aravinth <[email protected]>
nodejs · Jul 22, 2020 · 60d6be0 · 60d6be0
1 parent 0a43604
commit 60d6be0
Showing 1 changed file with 41 additions and 18 deletions.
diff --git a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md
@@ -7,48 +7,71 @@ labels: doc
 
 # 📗 API Reference Docs Problem
 
-<!------------------------------------------------------------------------------
+<!--
+
 Thank you for wanting to make nodejs.org better!
 
-This template is for issues with the Node.js API reference docs.
+This template is for issues with the Node.js API
+reference documentation.
 
-For more general support, please open an issue in
-our help repo at “https://github.com/nodejs/help”.
+For problems with nodejs.org beyond the API
+reference documentation, please open an issue
+using the issue tracker for our site repository.
 
-For the issue title, enter a one-line summary after “doc: ”.
-The “✍️” signifies a request for input. If unsure, do the best you can.
+  https://github.com/nodejs/nodejs.org
 
-If you found a problem with nodejs.org beyond the API reference docs, please
-open an issue in our website repo at “https://github.com/nodejs/nodejs.org”.
-------------------------------------------------------------------------------->
+For more general support, please open an issue
+using the issue tracker for our help repository.
+
+  https://github.com/nodejs/help
+
+---
+
+For the issue title, please enter a one-line
+summary after “doc: ” (preferably 50 characters
+or less and no more than 72).
+
+The “✍️” are placeholders signifying requests for
+input. Replace them with your responses.
+
+If you are unsure of something, do your best.
 
-<!--
-Version: output of “node -v”
-Platform: output of “uname -a” (UNIX), or version and 32 or 64-bit (Windows)
-Subsystem: if known, please specify affected core module name
 -->
 
+<!-- The output of “node --version”. -->
+
 - **Version**: ✍️
+
+<!-- The output of “uname -a” (UNIX) or version
+and 32-bit or 64-bit (Windows). -->
+
 - **Platform**: ✍️
+
+<!-- The name of affected core module. -->
+
 - **Subsystem**: ✍️
 
 ## Location
 
 _Section of the site where the content exists_
 
 Affected URL(s):
+
 - https://nodejs.org/api/✍️
 
-## Problem description
+## Description
 
-_Concise explanation of what you found to be problematic_
+_Concise explanation of the problem_
 
-<!-- If applicable, include any screenshots that may help solve the problem. -->
+<!-- If applicable, include any screenshots that
+may help solve the problem. -->
 
 ✍️
 
 ---
 
-<!-- Use “[x]” to check the box below if interested in contributing. -->
+<!-- Use “[x]” to check the box below if you are
+interested in contributing. -->
 
-- [ ] I would like to work on this issue and submit a pull request.
+- [ ] I would like to work on this issue and
+      submit a pull request.