Skip to content

Commit e6c12a3

Browse files
authored
Update CONTRIBUTING.md
1 parent 2d23857 commit e6c12a3

File tree

1 file changed

+37
-20
lines changed

1 file changed

+37
-20
lines changed

CONTRIBUTING.md

+37-20
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,55 @@
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

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

9-
## Contributing Code
13+
## Contributing code
1014

11-
We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (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:
1219

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.
14-
15-
```
20+
```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

21-
```
27+
```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.
33+
34+
## Pull request process
2635

27-
### Pull request process
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.
39+
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`.
41+
1. Ensure that any documentation is updated with the changes that are required
42+
by your change.
43+
1. Ensure that any samples are updated if the base image has been changed.
44+
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.
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.
2848

29-
1. Fork this repository
30-
2. 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`
31-
3. Ensure that any documentation is updated with the changes that are required by your fix.
32-
4. Ensure that any samples are updated if the base image has been changed.
33-
5. 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.
34-
6. We will assign the pull request to 2-3 people for review before it is merged.
49+
## Code of conduct
3550

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

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

0 commit comments

Comments
 (0)