|
3 | 3 |
|
4 | 4 | We welcome your contributions! There are multiple ways to contribute. |
5 | 5 |
|
6 | | -## Issues |
| 6 | +## Opening issues |
7 | 7 |
|
8 | | -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](./SECURITY.md). |
| 8 | +For bugs or enhancement requests, please file a GitHub issue unless it's |
| 9 | +security related. When filing a bug remember that the better written the bug is, |
| 10 | +the more likely it is to be fixed. If you think you've found a security |
| 11 | +vulnerability, do not raise a GitHub issue and follow the instructions in our |
| 12 | +[security policy](./SECURITY.md). |
9 | 13 |
|
10 | | -## Contributing Code |
| 14 | +## Contributing code |
11 | 15 |
|
12 | | -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). |
13 | | - |
14 | | -For pull requests to be accepted, the bottom of your commit message must have |
15 | | -the following line using the name and e-mail address you used for the OCA. |
| 16 | +We welcome your code contributions. Before submitting code via a pull request, |
| 17 | +you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and |
| 18 | +your commits need to include the following line using the name and e-mail |
| 19 | +address you used to sign the OCA: |
16 | 20 |
|
17 | 21 | ```text |
18 | 22 | Signed-off-by: Your Name <you@example.org> |
19 | 23 | ``` |
20 | 24 |
|
21 | | -This can be automatically added to pull requests by committing with: |
| 25 | +This can be automatically added to pull requests by committing with `--sign-off` |
| 26 | +or `-s`, e.g. |
22 | 27 |
|
23 | 28 | ```text |
24 | 29 | git commit --signoff |
25 | 30 | ``` |
26 | 31 |
|
27 | | -Only pull requests from committers that can be verified as having |
28 | | -signed the OCA can be accepted. |
| 32 | +Only pull requests from committers that can be verified as having signed the OCA |
| 33 | +can be accepted. |
29 | 34 |
|
30 | | -### Pull request process |
| 35 | +## Pull request process |
31 | 36 |
|
32 | | -1. Fork this repository |
| 37 | +1. Ensure there is an issue created to track and discuss the fix or enhancement |
| 38 | + you intend to submit. |
| 39 | +1. Fork this repository. |
33 | 40 | 1. Create a branch in your fork to implement the changes. We recommend using |
34 | | -the issue number as part of your branch name, e.g. `1234-fixes` |
| 41 | + the issue number as part of your branch name, e.g. `1234-fixes`. |
35 | 42 | 1. Ensure that any documentation is updated with the changes that are required |
36 | | -by your fix. |
| 43 | + by your change. |
37 | 44 | 1. Ensure that any samples are updated if the base image has been changed. |
38 | 45 | 1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly |
39 | | -what your changes are meant to do and provide simple steps on how to validate |
40 | | -your changes. Ensure that you reference the issue you created as well. |
| 46 | + what your changes are meant to do and provide simple steps on how to validate. |
| 47 | + your changes. Ensure that you reference the issue you created as well. |
41 | 48 | 1. We will assign the pull request to 2-3 people for review before it is merged. |
42 | 49 |
|
43 | | -## Code of Conduct |
| 50 | +## Code of conduct |
| 51 | + |
| 52 | +Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd |
| 53 | +like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC]. |
44 | 54 |
|
45 | | -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/) |
| 55 | +[OCA]: https://oca.opensource.oracle.com |
| 56 | +[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ |
0 commit comments