From 83774f95207e5ac0b01f2b4bb04056ddc54730aa Mon Sep 17 00:00:00 2001 From: Anthony Tuininga Date: Tue, 7 May 2024 20:33:12 -0600 Subject: [PATCH] Update templates and READMEs to take note of python-oracledb. --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++- .../documentation-and-example-improvements.md | 15 +++---- .../ISSUE_TEMPLATE/enhancement-requests.md | 15 +++---- .../general-questions-and-runtime-problems.md | 9 +++- .../ISSUE_TEMPLATE/installation-questions.md | 9 +++- .github/SECURITY.md | 38 +++++++++++++--- .github/SUPPORT.md | 6 ++- .github/pull_request_template.md | 20 ++------- CONTRIBUTING.md | 44 ++----------------- README.md | 12 ++++- 10 files changed, 93 insertions(+), 87 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 63133f7..0af4308 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 -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 diff --git a/.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md b/.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md index ad77f9c..cf10784 100644 --- a/.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md +++ b/.github/ISSUE_TEMPLATE/documentation-and-example-improvements.md @@ -9,16 +9,13 @@ assignees: '' - -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 index 199ecba..98aaa04 100644 --- a/.github/ISSUE_TEMPLATE/enhancement-requests.md +++ b/.github/ISSUE_TEMPLATE/enhancement-requests.md @@ -9,16 +9,13 @@ assignees: '' - -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 index 78d9d1d..b73bf70 100644 --- a/.github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md +++ b/.github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md @@ -11,7 +11,14 @@ assignees: '' 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. diff --git a/.github/ISSUE_TEMPLATE/installation-questions.md b/.github/ISSUE_TEMPLATE/installation-questions.md index 0a7b2a8..be7b94b 100644 --- a/.github/ISSUE_TEMPLATE/installation-questions.md +++ b/.github/ISSUE_TEMPLATE/installation-questions.md @@ -11,9 +11,16 @@ 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 + 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 diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 91c3b6f..25e76bf 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -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/ diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 3037228..eeceb44 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -1,7 +1,9 @@ # Python cx_Oracle Support -cx_Oracle is an Open Source project, so do some searching and reading -before asking questions. +**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 update to +this new driver. If you still have problems, open an issue on the new +repository.** ## cx_Oracle Installation issues diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5213271..9336c8f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,8 @@ Thanks for contributing! -Before submitting PRs for cx_Oracle you must have your signed *Oracle -Contributor Agreement* accepted. See https://oca.opensource.oracle.com +The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new +repository at https://github.com/oracle/python-oracledb. -If the problem solved is small, you may find it easier to open an Issue -describing the problem and its cause so we can create the fix. +Please submit your contributions to the python-oracledb repository. -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 -``` - -This can be automatically added to pull requests by committing with: - -``` -git commit --signoff -```` +No further releases under the cx_Oracle namespace are planned. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5010c7c..125cf13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,44 +1,8 @@ # 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). - -## 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 -``` - -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/) +No further releases under the cx_Oracle namespace are planned. diff --git a/README.md b/README.md index 64edd71..c441549 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,17 @@ See [/test][11]. ## 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