Update GitHub issue templates

cjbj · cjbj · commit b6eafc1d7f52 · 2020-06-27T12:21:33.000+10:00
diff --git a/.github/ISSUE_TEMPLATE/announcements.md b/.github/ISSUE_TEMPLATE/announcements.md
@@ -7,4 +7,4 @@ assignees: ''
 
 ---
 
-Let us know if you are speaking at a conference on node-oracledb, or have a new package or app that uses node-oracledb, or something similarly exciting.
+<!-- Let us know if you are speaking at a conference on node-oracledb, or have a new package or app that uses node-oracledb, or something similarly exciting. -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,26 +7,54 @@ assignees: ''
 
 ---
 
+<!--
+
+Thank you for using node-oracledb.
+
 **See https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html for how to report security issues**.
 
-1. With the async/await programming style, make sure you are using 'await' in the right places.
+Please answer these questions so we can help you.
+
+Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
+
+-->
+
+1. What versions are you using?
+
+<!--
+
+Give your database version.
+
+Also run node and show the output of:
+
+    process.platform
+    process.version
+    process.arch
+    require('oracledb').versionString
+    require('oracledb').oracleClientVersionString
+
+-->
 
 2. Is it an error or a hang or a crash?
 
-3. What error(s) you are seeing?
-**Cut and paste text showing the command you ran.  No screenshots.  Use a gist for long screen output and logs: see https://gist.github.com/**.
+3. What error(s) or behavior you are seeing?
+
+<!--
+
+Cut and paste text showing the command you ran.  No screenshots.
+
+Use a gist for long screen output and logs: see https://gist.github.com/
+
+-->
 
 4. Include a runnable Node.js script that shows the problem.
-Include all SQL needed to create the database schema.  Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
 
-5. Run node and show the output of:
+<!--
+
+Include all SQL needed to create the database schema.
+
+Use a gist for long code: see https://gist.github.com/
 
-```
-process.platform
-process.version
-process.arch
-require('oracledb').versionString
-require('oracledb').oracleClientVersionString
-```
+Format code by using three backticks on a line before and after code snippets.
 
-6. What is your Oracle Database version?
+-->
diff --git a/.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md b/.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md
@@ -7,8 +7,19 @@ assignees: ''
 
 ---
 
-- Include a link to the documentation section or the example
+<!--
 
-- Describe the confusion
+Thank you for using node-oracledb.
 
-- Suggest changes that would help
+Please answer these questions so we can help you.
+
+Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
+
+-->
+
+
+1. What is the link to the documentation section that needs improving?
+
+2. Describe the confusion
+
+3. Suggest changes that would help
diff --git a/.github/ISSUE_TEMPLATE/enhancement-requests.md b/.github/ISSUE_TEMPLATE/enhancement-requests.md
@@ -7,8 +7,18 @@ assignees: ''
 
 ---
 
-1. Review existing [enhancement requests](https://github.com/oracle/node-oracledb/labels/enhancement)
+<!--
 
-2. Describe your new request in detail
+Thank you for using node-oracledb.
 
-3. Give supporting information about tools and operating systems.  Give relevant product version numbers
+Review existing enhancement requests: https://github.com/oracle/node-oracledb/labels/enhancement
+
+Please answer these questions so we can help you.
+
+Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
+
+-->
+
+1. Describe your new request in detail
+
+2. Give supporting information about tools and operating systems.  Give relevant product version numbers
diff --git a/.github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md b/.github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md
@@ -7,24 +7,46 @@ assignees: ''
 
 ---
 
-1. Review the [user manual](https://oracle.github.io/node-oracledb/doc/api.html)
+<!--
+
+Thank you for using node-oracledb.
+
+Review the user manual: https://oracle.github.io/node-oracledb/doc/api.html
+
+Please answer these questions so we can help you.
+
+Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
+
+-->
+
+1. What versions are you using?
+
+<!--
+
+Give your database version.
+
+Also run node and show the output of:
+
+    process.platform
+    process.version
+    process.arch
+    require('oracledb').versionString
+    require('oracledb').oracleClientVersionString
+
+-->
 
 2. Describe the problem
-**Cut and paste text showing the command you ran.  No screenshots.  Use a gist for long screen output and logs: see https://gist.github.com/**.
+
+<!-- Cut and paste text showing the command you ran.  No screenshots. -->
 
 3. Include a runnable Node.js script that shows the problem.
-Include all SQL needed to create the database schema.  Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
 
-   The more details you give, the more we can help.
+<!--
+
+Include all SQL needed to create the database schema.
 
-4. Run node and show the output of:
+Use a gist for long code: see https://gist.github.com/
 
-```
-process.platform
-process.version
-process.arch
-require('oracledb').versionString
-require('oracledb').oracleClientVersionString
-```
+Format code by using three backticks on a line before and after code snippets.
 
-5. What is your Oracle Database version?
+-->
diff --git a/.github/ISSUE_TEMPLATE/installation-questions.md b/.github/ISSUE_TEMPLATE/installation-questions.md
@@ -7,33 +7,48 @@ assignees: ''
 
 ---
 
-# Do these first
+<!--
 
-- Review and follow the [installation instructions](https://oracle.github.io/node-oracledb/INSTALL.html)
+Thank you for using node-oracledb.
 
-- Review the [troubleshooting tips](https://oracle.github.io/node-oracledb/INSTALL.html#troubleshooting)
+Do these before creating a new issue:
 
-- If you have a `DPI-1047`, `DPI-1050` or `DPI-1072` error, review both the above again before opening an issue.
+    Review and follow the Installation Instructions: https://oracle.github.io/node-oracledb/INSTALL.html
 
-# Answer the following questions
+    Review the troubleshooting tips https://oracle.github.io/node-oracledb/INSTALL.html#troubleshooting
 
-1. Describe the problem and show the error you have.
-**Cut and paste text showing the command you ran.  No screenshots.  Use a gist for long screen output and logs: see https://gist.github.com/**.
+    Review the user manual: https://oracle.github.io/node-oracledb/doc/api.html.
 
-2. What Node.js version are you using?  Run node and show the output of:
+If you have a `DPI-1047`, `DPI-1050` or `DPI-1072` error, re-review the links above.
 
-```
-process.platform
-process.version
-process.arch
-require('oracledb').versionString
-require('oracledb').oracleClientVersionString
-```
+Please answer these questions so we can help you.
+
+-->
+
+1. What versions are you using?
+
+<!--
+
+Give your database version.
+
+Also run node and show the output of:
+
+    process.platform
+    process.version
+    process.arch
+    require('oracledb').versionString
+    require('oracledb').oracleClientVersionString
+
+-->
+
+2. Describe the problem.
+
+<!-- Cut and paste text showing the command you ran.  No screenshots. -->
 
 3. Are you installing into vanilla Node.js, or using something like Electron?
 
 4. Show the directory listing where your Oracle client libraries are installed (e.g. the Instant Client directory).  Is it 64-bit or 32-bit?
 
-5. Show what the `PATH` environment variable (on Windows) or `LD_LIBRARY_PATH` (on Linux) are set to?  On macOS, show what is in `~/lib`.
+5. Show what the `PATH` environment variable (on Windows) or `LD_LIBRARY_PATH` (on Linux) are set to?
 
 6. Show any Oracle environment variables set (e.g. ORACLE_HOME, ORACLE_BASE).
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,3 +1,5 @@
+<!--
+
 Thanks for contributing!
 
 Before submitting PRs for node-oracledb you must have your signed *Oracle Contributor Agreement* accepted.  See https://www.oracle.com/technetwork/community/oca-486395.html
@@ -8,12 +10,18 @@ If the problem solved is small, you may find it easier to open an Issue describi
 
 The bottom of your commit message must have the following line using your name and e-mail address as it appears in the OCA Signatories list.
 
+-->
+
 ```
 Signed-off-by: Your Name <you@example.org>
 ```
 
+<!--
+
 This can be automatically added to pull requests by committing with:
 
 ```
 git commit --signoff
 ````
+
+-->

Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,4 @@ assignees: ''`
`7`	`7`
`8`	`8`	`---`
`9`	`9`
`10`		`-Let us know if you are speaking at a conference on node-oracledb, or have a new package or app that uses node-oracledb, or something similarly exciting.`
	`10`	`+<!-- Let us know if you are speaking at a conference on node-oracledb, or have a new package or app that uses node-oracledb, or something similarly exciting. -->`