HackBase/python-cx_Oracle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update templates and READMEs to take note of python-oracledb.

Browse Source
This commit is contained in:
Anthony Tuininga 2024-05-07 20:33:12 -06:00
parent 6766bcaf27
commit 83774f9520
10 changed files with 93 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -13,7 +13,17 @@ Thank you for using cx_Oracle.
See https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html for how to report security issues See https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html for how to report security issues
Please answer these questions so we can help you. The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Update to python-oracledb, if possible, and submit your bug report to the
python-oracledb repository.
No further releases under the cx_Oracle namespace are planned.
Otherwise, please answer these questions so we can help you.
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 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

15
.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md vendored
View File

@ -9,16 +9,13 @@ assignees: ''
<!-- <!--
Thank you for using cx_Oracle. The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Please answer these questions so we can help you. Please submit your documentation and example improvements to the python-oracledb repository.
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 No further releases under the cx_Oracle namespace are planned.
--> -->
1. What is the link to the documentation section that needs improving?
2. Describe the confusion
3. Suggest changes that would help

15
.github/ISSUE_TEMPLATE/enhancement-requests.md vendored
View File

@ -9,16 +9,13 @@ assignees: ''
<!-- <!--
Thank you for using cx_Oracle. The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Review existing enhancement requests: https://github.com/oracle/python-cx_Oracle/labels/enhancement Please submit your enhancement requests to the python-oracledb repository.
Please answer these questions so we can help you. No further releases under the cx_Oracle namespace are planned.
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
--> -->
1. Describe your new request in detail
2. Give supporting information about tools and operating systems. Give relevant product version numbers

9
.github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md vendored
View File

@ -11,7 +11,14 @@ assignees: ''
Thank you for using cx_Oracle. Thank you for using cx_Oracle.
Review the user manual: https://cx-oracle.readthedocs.io/en/latest/index.html The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Update to python-oracledb, if possible.
Otherwise, review the cx_Oracle user manual: https://cx-oracle.readthedocs.io/en/latest/index.html
Please answer these questions so we can help you. Please answer these questions so we can help you.

9
.github/ISSUE_TEMPLATE/installation-questions.md vendored
View File

@ -11,9 +11,16 @@ assignees: ''
Thank you for using cx_Oracle. Thank you for using cx_Oracle.
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Do these before creating a new issue: Do these before creating a new issue:
Review and follow the Installation Instructions: https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html Update to python-oracledb, if possible.
Otherwise, 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 Review the troubleshooting tips: https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting

38
.github/SECURITY.md vendored
View File

@ -1,13 +1,37 @@
# Reporting Security Vulnerabilities # Reporting security vulnerabilities
Oracle values the independent security research community and believes that responsible disclosure of security vulnerabilities helps us ensure the security and privacy of all our users. Oracle values the independent security research community and believes that
responsible disclosure of security vulnerabilities helps us ensure the security
and privacy of all our users.
Please do NOT raise a GitHub Issue to report a security vulnerability. If you believe you have found a security vulnerability, please submit a report to secalert_us@oracle.com preferably with a proof of concept. We provide additional information on [how to report security vulnerabilities to Oracle](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html) which includes public encryption keys for secure email. Please do NOT raise a GitHub Issue to report a security vulnerability. If you
believe you have found a security vulnerability, please submit a report to
[secalert_us@oracle.com][1] preferably with a proof of concept. Please review
some additional information on [how to report security vulnerabilities to
Oracle][2]. We encourage people who contact Oracle Security to use email
encryption using [our encryption key][3].
We ask that you do not use other channels or contact project contributors directly. We ask that you do not use other channels or contact the project maintainers
directly.
Non-vulnerability related security issues such as great new ideas for security features are welcome on GitHub Issues. Non-vulnerability related security issues including ideas for new or improved
security features are welcome on GitHub Issues.
## Security-Related Information ## Security updates, alerts and bulletins
We will provide security related information such as a threat model, considerations for secure use, or any known security issues in our documentation. Please note that labs and sample code are intended to demonstrate a concept and may not be sufficiently hardened for production use. Security updates will be released on a regular cadence. Many of our projects
will typically release security fixes in conjunction with the Oracle Critical
Patch Update program. Additional information, including past advisories, is
available on our [security alerts][4] page.
## Security-related information
We will provide security related information such as a threat model,
considerations for secure use, or any known security issues in our
documentation. Please note that labs and sample code are intended to
demonstrate a concept and may not be sufficiently hardened for production use.
[1]: mailto:secalert_us@oracle.com
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
[4]: https://www.oracle.com/security-alerts/

6
.github/SUPPORT.md vendored
View File

@ -1,7 +1,9 @@
# Python cx_Oracle Support # Python cx_Oracle Support
cx_Oracle is an Open Source project, so do some searching and reading **The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a
before asking questions. new repository at https://github.com/oracle/python-oracledb. Please update to
this new driver. If you still have problems, open an issue on the new
repository.**
## cx_Oracle Installation issues ## cx_Oracle Installation issues

20
.github/pull_request_template.md vendored
View File

@ -1,20 +1,8 @@
Thanks for contributing! Thanks for contributing!
Before submitting PRs for cx_Oracle you must have your signed *Oracle The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
Contributor Agreement* accepted. See https://oca.opensource.oracle.com repository at https://github.com/oracle/python-oracledb.
If the problem solved is small, you may find it easier to open an Issue Please submit your contributions to the python-oracledb repository.
describing the problem and its cause so we can create the fix.
The bottom of your commit message must have the following line using your name No further releases under the cx_Oracle namespace are planned.
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
````

44
CONTRIBUTING.md
View File

@ -1,44 +1,8 @@
# Contributing # Contributing
We welcome your contributions! There are multiple ways to contribute. The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb
## Issues Please submit your contributions to the python-oracledb repository.
For bugs or enhancement requests, please file a GitHub issue unless it's security related. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. If you think you've found a security vulnerability, do not raise a GitHub issue and follow the instructions on our [Security Policy](./.github/SECURITY.md). No further releases under the cx_Oracle namespace are planned.
## Contributing Code
We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://oca.opensource.oracle.com) (OCA).
For pull requests to be accepted, the bottom of your commit message must have
the following line using the name and e-mail address you used for the OCA.
```text
Signed-off-by: Your Name <you@example.org>
```
This can be automatically added to pull requests by committing with:
```text
git commit --signoff
```
Only pull requests from committers that can be verified as having
signed the OCA can be accepted.
### Pull request process
1. Fork this repository
1. Create a branch in your fork to implement the changes. We recommend using
the issue number as part of your branch name, e.g. `1234-fixes`
1. Ensure that any documentation is updated with the changes that are required
by your fix.
1. Ensure that any samples are updated if the base image has been changed.
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
what your changes are meant to do and provide simple steps on how to validate
your changes. Ensure that you reference the issue you created as well.
1. We will review your PR before it is merged.
## Code of Conduct
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd like more specific guidelines see the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)

12
README.md
View File

@ -53,7 +53,17 @@ See [/test][11].
## Contributing ## Contributing
See [CONTRIBUTING](https://github.com/oracle/python-cx_Oracle/blob/main/CONTRIBUTING.md) The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb
Please submit your contributions to the python-oracledb repository.
No further releases under the cx_Oracle namespace are planned.
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security
vulnerability disclosure process.
## License ## License