Skip to content

Commit dea2f25

Browse files
Address PR #145 and some additional line wrapping.
1 parent b44e22f commit dea2f25

File tree

3 files changed

+41
-27
lines changed

3 files changed

+41
-27
lines changed

CONTRIBUTING.md

+32-25
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,58 @@
1-
# Contributing
1+
# Contributing to this repository
22

33
We welcome your contributions! There are multiple ways to contribute.
44

5-
## Issues
5+
## Opening issues
66

77
For bugs or enhancement requests, please file a GitHub issue unless it's
8-
security related. When filing a bug remember that the better written the bug
9-
is, the more likely it is to be fixed. If you think you've found a security
10-
vulnerability, do not raise a GitHub issue and follow the instructions on our
11-
[Security Policy](./.github/SECURITY.md).
8+
security related. When filing a bug remember that the better written the bug is,
9+
the more likely it is to be fixed. If you think you've found a security
10+
vulnerability, do not raise a GitHub issue and follow the instructions in our
11+
[security policy](./SECURITY.md).
1212

13-
## Contributing Code
13+
## Contributing code
1414

15-
To get started, you will need to sign the [Oracle Contributor
16-
Agreement](https://oca.opensource.oracle.com) (OCA).
17-
18-
For pull requests to be accepted, the bottom of your commit message must have
19-
the following line using the name and e-mail address you used for the OCA.
15+
We welcome your code contributions. Before submitting code via a pull request,
16+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
17+
your commits need to include the following line using the name and e-mail
18+
address you used to sign the OCA:
2019

2120
```text
2221
Signed-off-by: Your Name <[email protected]>
2322
```
2423

25-
This can be automatically added to pull requests by committing with:
24+
This can be automatically added to pull requests by committing with
25+
`--sign-off` or `-s`, e.g.
2626

2727
```text
2828
git commit --signoff
2929
```
3030

31-
Only pull requests from committers that can be verified as having
32-
signed the OCA can be accepted.
31+
Only pull requests from committers that can be verified as having signed the
32+
OCA can be accepted.
3333

34-
### Pull request process
34+
## Pull request process
3535

36-
1. Fork this repository
36+
1. Ensure there is an issue created to track and discuss the fix or enhancement
37+
you intend to submit.
38+
1. Fork this repository.
3739
1. Create a branch in your fork to implement the changes. We recommend using
38-
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`.
3941
1. Ensure that any documentation is updated with the changes that are required
40-
by your fix.
42+
by your change.
4143
1. Ensure that any samples are updated if the base image has been changed.
4244
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
43-
what your changes are meant to do and provide simple steps on how to validate
44-
your changes. Ensure that you reference the issue you created as well.
45-
1. We will review your PR before it is merged.
45+
what your changes are meant to do and provide simple steps on how to validate.
46+
your changes. Ensure that you reference the issue you created as well.
47+
1. We will assign the pull request to 2-3 people for review before it is merged.
48+
49+
Note we merge to an internal repo first before pushing back to GitHub.
4650

47-
## Code of Conduct
51+
## Code of conduct
4852

4953
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
50-
like more specific guidelines see the [Contributor Covenant Code of
51-
Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
54+
like more specific guidelines, see the [Contributor Covenant Code of
55+
Conduct][COC].
56+
57+
[OCA]: https://oca.opensource.oracle.com
58+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,18 @@ See [/tests][tests]
6666

6767
## Contributing
6868

69-
See [CONTRIBUTING](https://github.com/oracle/python-oracledb/blob/main/CONTRIBUTING.md)
69+
This project welcomes contributions from the community. Before submitting a
70+
pull request, please [review our contribution guide](./CONTRIBUTING.md).
71+
72+
## Security
73+
74+
Please consult the [security guide](./SECURITY.md) for our responsible security
75+
vulnerability disclosure process.
7076

7177
## License
7278

73-
See [LICENSE][license], [THIRD_PARTY_LICENSES][tplicense], and [NOTICE][notice].
79+
See [LICENSE][license], [THIRD_PARTY_LICENSES][tplicense], and
80+
[NOTICE][notice].
7481

7582
[python]: https://www.python.org/
7683
[oracledb]: https://www.oracle.com/database/
File renamed without changes.

0 commit comments

Comments
 (0)