Skip to content

Commit 73573c8

Browse files
Improve GitHub issue templates; questions should be discussions, not
issues.
1 parent 5852bae commit 73573c8

6 files changed

+26
-98
lines changed

.github/ISSUE_TEMPLATE/announcements.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,10 @@ assignees: ''
77

88
---
99

10-
<!-- Let us know if you are speaking at a conference on python-oracledb, or have a new package or app that uses python-oracledb, or something similarly exciting. -->
10+
<!--
11+
12+
Please start a discussion at https://github.com/oracle/python-oracledb/discussions instead of creating an Issue.
13+
14+
Let us know if you are speaking at a conference on python-oracledb, or have a new package or app that uses python-oracledb, or something similarly exciting.
15+
16+
-->

.github/ISSUE_TEMPLATE/bug_report.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,15 @@ Use a gist for long screen output and logs: see https://gist.github.com/
5454
5555
-->
5656

57-
4. Include a runnable Python script that shows the problem.
57+
4. Does your application call init_oracle_client()?
58+
59+
<!--
60+
61+
This tells us whether you are using the python-oracledb Thin or Thick mode.
62+
63+
-->
64+
65+
5. Include a runnable Python script that shows the problem.
5866

5967
<!--
6068
@@ -63,7 +71,7 @@ Include all SQL needed to create the database schema.
6371
Format code by using three backticks on a line before and after code snippets, for example:
6472
6573
```
66-
import python-oracledb
74+
import oracledb
6775
```
6876
6977
-->

.github/ISSUE_TEMPLATE/enhancement-requests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ assignees: ''
1111
1212
Thank you for using python-oracledb.
1313
14-
Review existing enhancement requests: https://github.com/oracle/python-python-oracledb/labels/enhancement
14+
Review existing enhancement requests: https://github.com/oracle/python-oracledb/labels/enhancement
1515
1616
Please answer these questions so we can help you.
1717

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

+2-50
Original file line numberDiff line numberDiff line change
@@ -9,56 +9,8 @@ assignees: ''
99

1010
<!--
1111
12-
Thank you for using python-oracledb.
12+
Please start a discussion at https://github.com/oracle/python-oracledb/discussions instead of creating an Issue.
1313
14-
Review the user manual: https://python-oracledb.readthedocs.io/en/latest/index.html
15-
16-
Please answer these questions so we can help you.
17-
18-
Use Markdown syntax, see https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
19-
20-
GitHub issues that are not updated for a month may be automatically closed. Feel free to update them at any time.
21-
22-
-->
23-
24-
1. What versions are you using?
25-
26-
<!--
27-
28-
Give your database version.
29-
30-
Also run Python and show the output of:
31-
32-
import sys
33-
import platform
34-
35-
print("platform.platform:", platform.platform())
36-
print("sys.maxsize > 2**32:", sys.maxsize > 2**32)
37-
print("platform.python_version:", platform.python_version())
38-
39-
And:
40-
41-
import oracledb
42-
print("oracledb.__version__:", oracledb.__version__)
43-
44-
-->
45-
46-
2. Describe the problem
47-
48-
<!-- Cut and paste text showing the command you ran. No screenshots. -->
49-
50-
3. Include a runnable Python script that shows the problem.
51-
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/
57-
58-
Format code by using three backticks on a line before and after code snippets, for example:
59-
60-
```
61-
import python-oracledb
62-
```
14+
Give as much background information as possible: versions, runnable code, all SQL to create tables etc.
6315
6416
-->

.github/ISSUE_TEMPLATE/installation-questions.md

+5-40
Original file line numberDiff line numberDiff line change
@@ -9,49 +9,14 @@ assignees: ''
99

1010
<!--
1111
12-
Thank you for using python-oracledb.
12+
Please start a discussion at https://github.com/oracle/python-oracledb/discussions instead of creating an Issue.
1313
14-
Do these before creating a new issue:
14+
Give as much background information as possible: versions, runnable code, all SQL to create tables etc.
1515
16-
Review and follow the Installation Instructions: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
16+
But first Review:
1717
18-
Review the troubleshooting tips: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting
18+
- the Installation Instructions: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
1919
20-
Review the user manual: https://python-oracledb.readthedocs.io/en/latest/index.html
21-
22-
If you have a `DPI-1047`, `DPI-1050` or `DPI-1072` error, re-review the links above.
23-
24-
Google any errors.
25-
26-
Then please answer these questions so we can help you.
27-
28-
GitHub issues that are not updated for a month may be automatically closed. Feel free to update them at any time.
29-
30-
-->
31-
32-
1. What versions are you using?
33-
34-
<!--
35-
36-
Give your database version.
37-
38-
Also run Python and show the output of:
39-
40-
import sys
41-
import platform
42-
43-
print("platform.platform:", platform.platform())
44-
print("sys.maxsize > 2**32:", sys.maxsize > 2**32)
45-
print("platform.python_version:", platform.python_version())
20+
- the troubleshooting tips: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting
4621
4722
-->
48-
49-
2. Describe the problem
50-
51-
<!-- Cut and paste text showing the command you ran. No screenshots. -->
52-
53-
3. Show the directory listing where your Oracle Client libraries are installed (e.g. the Instant Client directory). Is it 64-bit or 32-bit?
54-
55-
4. Show what the `PATH` environment variable (on Windows) or `LD_LIBRARY_PATH` (on Linux) is set to?
56-
57-
5. Show any Oracle environment variables set (e.g. ORACLE_HOME, ORACLE_BASE).

.github/SUPPORT.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,4 @@ is [here](http://python-oracledb.readthedocs.io/en/latest/)
2626

2727
## Got a python-oracledb question?
2828

29-
Ask at [GitHub](https://github.com/oracle/python-python-oracledb/issues)
30-
31-
When opening a new issue, fill in the template that will be shown.
32-
Include enough information for people to understand your problem.
29+
Start a [Discussion](https://github.com/oracle/python-oracledb/discussions) on GitHub.

0 commit comments

Comments
 (0)