Skip to content

Commit c6d2131

Browse files
authored
Update CONTRIBUTING.md
1 parent eb9ab7f commit c6d2131

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

CONTRIBUTING.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,34 @@
22

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

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

7-
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.
7+
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 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).
812

913
## Contributing Code
1014

11-
We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement (OCA)](https://oca.opensource.oracle.com/).
12-
13-
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.
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:
1419

1520
```text
1621
Signed-off-by: Your Name <[email protected]>
1722
```
1823

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

2127
```text
2228
git commit --signoff
2329
```
2430

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

2734
## Pull request process
2835

@@ -224,7 +231,10 @@ Run the upload command to upload all archives in dist/*
224231
python3 -m twine upload dist/*
225232
```
226233

234+
## Code of conduct
227235

228-
## Code of Conduct
236+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
237+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
229238

230-
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/)
239+
[OCA]: https://oca.opensource.oracle.com
240+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

0 commit comments

Comments
 (0)