Skip to content

Commit 4f9f0e9

Browse files
authored
Merge pull request #118 from oracle/docs-updates
Update docs
2 parents 3bad8ff + fbd18ba commit 4f9f0e9

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ vulnerability, do not raise a GitHub issue and follow the instructions in our
1313
## Contributing code
1414

1515
We welcome your code contributions. Before submitting code via a pull request,
16-
you will need to haved signed the [Oracle Contributor Agreement][OCA] (OCA) and
16+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
1717
your commits need to include the following line using the name and e-mail
1818
address you used to sign the OCA:
1919

@@ -35,14 +35,14 @@ can be accepted.
3535

3636
1. Ensure there is an issue created to track and discuss the fix or enhancement
3737
you intend to submit.
38-
1. Fork this repository
38+
1. Fork this repository.
3939
1. Create a branch in your fork to implement the changes. We recommend using
40-
the issue number as part of your branch name, e.g. `1234-fixes`
40+
the issue number as part of your branch name, e.g. `1234-fixes`.
4141
1. Ensure that any documentation is updated with the changes that are required
4242
by your change.
4343
1. Ensure that any samples are updated if the base image has been changed.
4444
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
45-
what your changes are meant to do and provide simple steps on how to validate
45+
what your changes are meant to do and provide simple steps on how to validate.
4646
your changes. Ensure that you reference the issue you created as well.
4747
1. We will assign the pull request to 2-3 people for review before it is merged.
4848

@@ -51,5 +51,5 @@ can be accepted.
5151
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
5252
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
5353

54-
[OCA]: https://www.oracle.com/technetwork/community/oca-486395.html
54+
[OCA]: https://oca.opensource.oracle.com
5555
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ declare the dependency in your project, ie:
4949
</dependency>
5050
```
5151

52-
# Installation
52+
## Installation
5353
Oracle R2DBC can be obtained from Maven Central.
5454
```xml
5555
<dependency>
@@ -78,7 +78,7 @@ Oracle R2DBC is compatible with JDK 11 (or newer), and has the following runtime
7878
The Oracle R2DBC Driver has been verified with Oracle Database versions 18, 19,
7979
and 21.
8080

81-
# Code Examples
81+
## Code Examples
8282

8383
The following method returns an Oracle R2DBC `ConnectionFactory`
8484
```java
@@ -143,31 +143,31 @@ is called.
143143

144144
Additional code examples can be found [here](sample).
145145

146-
# Help
146+
## Help
147147
For help programming with Oracle R2DBC, ask questions on Stack Overflow tagged with [[oracle] and [r2dbc]](https://stackoverflow.com/tags/oracle+r2dbc). The development team monitors Stack Overflow regularly.
148148

149149
Issues may be opened as described in [our contribution guide](CONTRIBUTING.md).
150150

151-
# Contributing
151+
## Contributing
152152

153153
This project welcomes contributions from the community. Before submitting a pull
154154
request, please [review our contribution guide](./CONTRIBUTING.md).
155155

156-
# Security
156+
## Security
157157

158158
Please consult the [security guide](./SECURITY.md) for our responsible security
159159
vulnerability disclosure process.
160160

161-
# License
161+
## License
162162

163-
Copyright (c) 2021 Oracle and/or its affiliates.
163+
Copyright (c) 2021, 2023 Oracle and/or its affiliates.
164164

165165
This software is dual-licensed to you under the Universal Permissive License
166166
(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License
167167
2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
168168
either license.
169169

170-
# Documentation
170+
## Documentation
171171
This document specifies the behavior of the R2DBC SPI as implemented for the
172172
Oracle Database. This SPI implementation is referred to as the "Oracle R2DBC
173173
Driver" or "Oracle R2DBC" throughout the remainder of this document.

SECURITY.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ and privacy of all our users.
66

77
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
88
believe you have found a security vulnerability, please submit a report to
9-
<mailto:[email protected]> preferably with a proof of concept. Please review
10-
some additional information on [how to report security vulnerabilities to Oracle][1].
9+
[[email protected]][1] preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][2].
1111
We encourage people who contact Oracle Security to use email encryption using
12-
[our encryption key][2].
12+
[our encryption key][3].
1313

1414
We ask that you do not use other channels or contact the project maintainers
1515
directly.
@@ -21,10 +21,8 @@ security features are welcome on GitHub Issues.
2121

2222
Security updates will be released on a regular cadence. Many of our projects
2323
will typically release security fixes in conjunction with the
24-
[Oracle Critical Patch Update][3] program. Security updates are released on the
25-
Tuesday closest to the 17th day of January, April, July and October. A pre-release
26-
announcement will be published on the Thursday preceding each release. Additional
27-
information, including past advisories, is available on our [security alerts][3]
24+
[Oracle Critical Patch Update][3] program. Additional
25+
information, including past advisories, is available on our [security alerts][4]
2826
page.
2927

3028
## Security-related information
@@ -34,6 +32,7 @@ for secure use, or any known security issues in our documentation. Please note
3432
that labs and sample code are intended to demonstrate a concept and may not be
3533
sufficiently hardened for production use.
3634

37-
[1]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
38-
[2]: https://www.oracle.com/security-alerts/encryptionkey.html
39-
[3]: https://www.oracle.com/security-alerts/
35+
[1]: mailto:[email protected]
36+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
37+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
38+
[4]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)