Compare commits
3 Commits
main
...
docs-updat
Author | SHA1 | Date |
---|---|---|
![]() |
505d7bda75 | |
![]() |
4a4c93a99c | |
![]() |
ef072ee326 |
|
@ -1,44 +1,55 @@
|
||||||
# Contributing
|
# Contributing to this repository
|
||||||
|
|
||||||
We welcome your contributions! There are multiple ways to contribute.
|
We welcome your contributions! There are multiple ways to contribute.
|
||||||
|
|
||||||
## Issues
|
## Opening issues
|
||||||
|
|
||||||
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).
|
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 in our
|
||||||
|
[security policy](./SECURITY.md).
|
||||||
|
|
||||||
## Contributing Code
|
## 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).
|
We welcome your code contributions. Before submitting code via a pull request,
|
||||||
|
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
|
||||||
For pull requests to be accepted, the bottom of your commit message must have
|
your commits need to include the following line using the name and e-mail
|
||||||
the following line using the name and e-mail address you used for the OCA.
|
address you used to sign the OCA:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Signed-off-by: Your Name <you@example.org>
|
Signed-off-by: Your Name <you@example.org>
|
||||||
```
|
```
|
||||||
|
|
||||||
This can be automatically added to pull requests by committing with:
|
This can be automatically added to pull requests by committing with `--sign-off`
|
||||||
|
or `-s`, e.g.
|
||||||
|
|
||||||
```text
|
```text
|
||||||
git commit --signoff
|
git commit --signoff
|
||||||
```
|
```
|
||||||
|
|
||||||
Only pull requests from committers that can be verified as having
|
Only pull requests from committers that can be verified as having signed the OCA
|
||||||
signed the OCA can be accepted.
|
can be accepted.
|
||||||
|
|
||||||
### Pull request process
|
## Pull request process
|
||||||
|
|
||||||
1. Fork this repository
|
1. Ensure there is an issue created to track and discuss the fix or enhancement
|
||||||
|
you intend to submit.
|
||||||
|
1. Fork this repository.
|
||||||
1. Create a branch in your fork to implement the changes. We recommend using
|
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`
|
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
|
1. Ensure that any documentation is updated with the changes that are required
|
||||||
by your fix.
|
by your change.
|
||||||
1. Ensure that any samples are updated if the base image has been changed.
|
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
|
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
|
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.
|
your changes. Ensure that you reference the issue you created as well.
|
||||||
1. We will review your PR before it is merged.
|
1. We will assign the pull request to 2-3 people for review before it is merged.
|
||||||
|
|
||||||
## Code of Conduct
|
## 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/)
|
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][COC].
|
||||||
|
|
||||||
|
[OCA]: https://oca.opensource.oracle.com
|
||||||
|
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
|
||||||
|
|
|
@ -53,7 +53,11 @@ See [/test][11].
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
See [CONTRIBUTING](https://github.com/oracle/python-cx_Oracle/blob/main/CONTRIBUTING.md)
|
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,38 @@
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
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 the project maintainers
|
||||||
|
directly.
|
||||||
|
|
||||||
|
Non-vulnerability related security issues including ideas for new or improved
|
||||||
|
security features are welcome on GitHub Issues.
|
||||||
|
|
||||||
|
## Security updates, alerts and bulletins
|
||||||
|
|
||||||
|
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/
|
Loading…
Reference in New Issue