Use new issue template format.

This commit is contained in:
Anthony Tuininga 2019-11-20 14:36:38 -07:00
parent 6f12ea7363
commit 3f27185b9c
7 changed files with 157 additions and 45 deletions

10
.github/ISSUE_TEMPLATE/announcements.md vendored Normal file
View File

@ -0,0 +1,10 @@
---
name: Announcements
about: Use this if you are sharing something interesting
title: ''
labels: announcement
assignees: ''
---
Let us know if you are speaking at a conference on cx_Oracle, or have a new package or app that uses cx_Oracle, or something similarly exciting.

41
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,41 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**See https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html for how to report security issues**.
For other issues:
1. Is it an error or a hang or a crash?
2. 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. Include a runnable Python script that shows the problem.
Include all SQL needed to create the database schema.
4. Show the output of:
```
import sys
import platform
print("platform.platform:", platform.platform())
print("sys.maxsize > 2**32:", sys.maxsize > 2**32)
print("platform.python_version:", platform.python_version())
```
And:
```
import cx_Oracle
print("cx_Oracle.version:", cx_Oracle.version)
print("cx_Oracle.clientversion:", cx_Oracle.clientversion())
```
5. What is your Oracle Database version?

View File

@ -0,0 +1,14 @@
---
name: Documentation and Example Improvements
about: Use this to suggest changes to documentation and examples
title: ''
labels: bug
assignees: ''
---
- Include a link to the documentation section or the example
- Describe the confusion
- Suggest changes that would help

View File

@ -0,0 +1,14 @@
---
name: Enhancement Requests
about: Use this for enhancement requests
title: ''
labels: enhancement
assignees: ''
---
1. Review existing [enhancement requests](https://github.com/oracle/python-cx_Oracle/labels/enhancement)
2. Describe your new request in detail
3. Give supporting information about tools and operating systems. Give relevant product version numbers

View File

@ -0,0 +1,38 @@
---
name: General Questions and Runtime Problems
about: For general cx_Oracle questions
title: ''
labels: question
assignees: ''
---
1. Review the [cx_Oracle Documentation](https://cx-oracle.readthedocs.io/en/latest/index.html). Review your output and logs. **Google any errors**
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/**.
3. Include a runnable Python 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.
4. Show the output of:
```
import sys
import platform
print("platform.platform:", platform.platform())
print("sys.maxsize > 2**32:", sys.maxsize > 2**32)
print("platform.python_version:", platform.python_version())
```
And:
```
import cx_Oracle
print("cx_Oracle.version:", cx_Oracle.version)
print("cx_Oracle.clientversion:", cx_Oracle.clientversion())
```
5. What is your Oracle Database version?

View File

@ -0,0 +1,40 @@
---
name: Installation Questions
about: Use this for cx_Oracle installation questions
title: ''
labels: install & configuration
assignees: ''
---
# Do these first
- Review and follow the [installation instructions](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html)
- Review the [troubleshooting tips](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting)
- If you have a `DPI-1047`, `DPI-1050` or `DPI-1072` error, review both the above again before opening an issue.
- **Google any errors**
# Answer the following questions
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/**.
2. Show the output of:
```
import sys
import platform
print("platform.platform:", platform.platform())
print("sys.maxsize > 2**32:", sys.maxsize > 2**32)
print("platform.python_version:", platform.python_version())
```
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?
4. Show what the `PATH` environment variable (on Windows) or `LD_LIBRARY_PATH` (on Linux) is set to? On macOS, show what is in `~/lib`.
5. Show any Oracle environment variables set (e.g. ORACLE_HOME, ORACLE_BASE).

View File

@ -1,45 +0,0 @@
*Delete unnecessary parts of this template.*
### For security issues:
See https://www.oracle.com/support/assurance/vulnerability-remediation/reporting-security-vulnerabilities.html for how to report security issues.
### For general questions:
Describe exactly what you did and what you want to happen.
Use the questions at the bottom of this template as a guide.
Use Markdown syntax, particularly for code blocks: see https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code
### For installation issues:
Use a gist for screen output and logs: see https://gist.github.com/
**Do not paste long output into this issue**
Review your output and logs. **Google any errors**
Try to install in a different way. Try some potential solutions.
Review the install instructions at
http://cx-oracle.readthedocs.io/en/latest/installation.html
#### Answer the following questions:
1. What is your version of Python? Is it 32-bit or 64-bit?
2. What is your cx_Oracle version?
3. What *exact* command caused the problem (e.g. what command did you try to install with)? Who were you logged in as?
4. What error(s) you are seeing?
5. What OS (and version) is Python executing on?
6. What is your version of the Oracle client (e.g. Instant Client)? How was it installed? Where is it installed?
7. What is your Oracle Database version?
8. What is the `PATH` environment variable (on Windows) or `LD_LIBRARY_PATH` (on Linux) set to? On macOS, what is in `~/lib`?
9. What Oracle environment variables did you set? How *exactly* did you set them?
10. Do you have a small, single Python script that immediately runs to show us the problem?