Skip to content

Commit b6eafc1

Browse files
cjbjcjbj
committed
Update GitHub issue templates
1 parent 472a0be commit b6eafc1

7 files changed

+143
-49
lines changed

‎.github/ISSUE_TEMPLATE/announcements.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ assignees: ''
77

88
---
99

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

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,54 @@ assignees: ''
77

88
---
99

10+
<!--
11+
12+
Thank you for using node-oracledb.
13+
1014
**See https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html for how to report security issues**.
1115
12-
1. With the async/await programming style, make sure you are using 'await' in the right places.
16+
Please answer these questions so we can help you.
17+
18+
Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
19+
20+
-->
21+
22+
1. What versions are you using?
23+
24+
<!--
25+
26+
Give your database version.
27+
28+
Also run node and show the output of:
29+
30+
process.platform
31+
process.version
32+
process.arch
33+
require('oracledb').versionString
34+
require('oracledb').oracleClientVersionString
35+
36+
-->
1337

1438
2. Is it an error or a hang or a crash?
1539

16-
3. What error(s) you are seeing?
17-
**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/**.
40+
3. What error(s) or behavior you are seeing?
41+
42+
<!--
43+
44+
Cut and paste text showing the command you ran. No screenshots.
45+
46+
Use a gist for long screen output and logs: see https://gist.github.com/
47+
48+
-->
1849

1950
4. Include a runnable Node.js script that shows the problem.
20-
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
2151

22-
5. Run node and show the output of:
52+
<!--
53+
54+
Include all SQL needed to create the database schema.
55+
56+
Use a gist for long code: see https://gist.github.com/
2357
24-
```
25-
process.platform
26-
process.version
27-
process.arch
28-
require('oracledb').versionString
29-
require('oracledb').oracleClientVersionString
30-
```
58+
Format code by using three backticks on a line before and after code snippets.
3159
32-
6. What is your Oracle Database version?
60+
-->

‎.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,19 @@ assignees: ''
77

88
---
99

10-
- Include a link to the documentation section or the example
10+
<!--
1111
12-
- Describe the confusion
12+
Thank you for using node-oracledb.
1313
14-
- Suggest changes that would help
14+
Please answer these questions so we can help you.
15+
16+
Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
17+
18+
-->
19+
20+
21+
1. What is the link to the documentation section that needs improving?
22+
23+
2. Describe the confusion
24+
25+
3. Suggest changes that would help

‎.github/ISSUE_TEMPLATE/enhancement-requests.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,18 @@ assignees: ''
77

88
---
99

10-
1. Review existing [enhancement requests](https://github.com/oracle/node-oracledb/labels/enhancement)
10+
<!--
1111
12-
2. Describe your new request in detail
12+
Thank you for using node-oracledb.
1313
14-
3. Give supporting information about tools and operating systems. Give relevant product version numbers
14+
Review existing enhancement requests: https://github.com/oracle/node-oracledb/labels/enhancement
15+
16+
Please answer these questions so we can help you.
17+
18+
Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
19+
20+
-->
21+
22+
1. Describe your new request in detail
23+
24+
2. Give supporting information about tools and operating systems. Give relevant product version numbers

‎.github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md‎

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,46 @@ assignees: ''
77

88
---
99

10-
1. Review the [user manual](https://oracle.github.io/node-oracledb/doc/api.html)
10+
<!--
11+
12+
Thank you for using node-oracledb.
13+
14+
Review the user manual: https://oracle.github.io/node-oracledb/doc/api.html
15+
16+
Please answer these questions so we can help you.
17+
18+
Use Markdown syntax, see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax
19+
20+
-->
21+
22+
1. What versions are you using?
23+
24+
<!--
25+
26+
Give your database version.
27+
28+
Also run node and show the output of:
29+
30+
process.platform
31+
process.version
32+
process.arch
33+
require('oracledb').versionString
34+
require('oracledb').oracleClientVersionString
35+
36+
-->
1137

1238
2. Describe the problem
13-
**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/**.
39+
40+
<!-- Cut and paste text showing the command you ran. No screenshots. -->
1441

1542
3. Include a runnable Node.js script that shows the problem.
16-
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
1743

18-
The more details you give, the more we can help.
44+
<!--
45+
46+
Include all SQL needed to create the database schema.
1947
20-
4. Run node and show the output of:
48+
Use a gist for long code: see https://gist.github.com/
2149
22-
```
23-
process.platform
24-
process.version
25-
process.arch
26-
require('oracledb').versionString
27-
require('oracledb').oracleClientVersionString
28-
```
50+
Format code by using three backticks on a line before and after code snippets.
2951
30-
5. What is your Oracle Database version?
52+
-->

‎.github/ISSUE_TEMPLATE/installation-questions.md‎

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,48 @@ assignees: ''
77

88
---
99

10-
# Do these first
10+
<!--
1111
12-
- Review and follow the [installation instructions](https://oracle.github.io/node-oracledb/INSTALL.html)
12+
Thank you for using node-oracledb.
1313
14-
- Review the [troubleshooting tips](https://oracle.github.io/node-oracledb/INSTALL.html#troubleshooting)
14+
Do these before creating a new issue:
1515
16-
- If you have a `DPI-1047`, `DPI-1050` or `DPI-1072` error, review both the above again before opening an issue.
16+
Review and follow the Installation Instructions: https://oracle.github.io/node-oracledb/INSTALL.html
1717
18-
# Answer the following questions
18+
Review the troubleshooting tips https://oracle.github.io/node-oracledb/INSTALL.html#troubleshooting
1919
20-
1. Describe the problem and show the error you have.
21-
**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/**.
20+
Review the user manual: https://oracle.github.io/node-oracledb/doc/api.html.
2221
23-
2. What Node.js version are you using? Run node and show the output of:
22+
If you have a `DPI-1047`, `DPI-1050` or `DPI-1072` error, re-review the links above.
2423
25-
```
26-
process.platform
27-
process.version
28-
process.arch
29-
require('oracledb').versionString
30-
require('oracledb').oracleClientVersionString
31-
```
24+
Please answer these questions so we can help you.
25+
26+
-->
27+
28+
1. What versions are you using?
29+
30+
<!--
31+
32+
Give your database version.
33+
34+
Also run node and show the output of:
35+
36+
process.platform
37+
process.version
38+
process.arch
39+
require('oracledb').versionString
40+
require('oracledb').oracleClientVersionString
41+
42+
-->
43+
44+
2. Describe the problem.
45+
46+
<!-- Cut and paste text showing the command you ran. No screenshots. -->
3247

3348
3. Are you installing into vanilla Node.js, or using something like Electron?
3449

3550
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?
3651

37-
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`.
52+
5. Show what the `PATH` environment variable (on Windows) or `LD_LIBRARY_PATH` (on Linux) are set to?
3853

3954
6. Show any Oracle environment variables set (e.g. ORACLE_HOME, ORACLE_BASE).

‎.github/pull_request_template.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!--
2+
13
Thanks for contributing!
24
35
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
810
911
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.
1012
13+
-->
14+
1115
```
1216
Signed-off-by: Your Name <[email protected]>
1317
```
1418

19+
<!--
20+
1521
This can be automatically added to pull requests by committing with:
1622
1723
```
1824
git commit --signoff
1925
````
26+
27+
-->

0 commit comments

Comments
 (0)