|
1 |
| -# Contributing |
| 1 | +# Contributing to this repository |
2 | 2 |
|
3 | 3 | We welcome your contributions! There are multiple ways to contribute.
|
4 | 4 |
|
5 |
| -## Issues |
| 5 | +## Opening issues |
6 | 6 |
|
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). |
8 | 12 |
|
9 |
| -## Contributing Code |
| 13 | +## Contributing code |
10 | 14 |
|
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: |
12 | 19 |
|
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 |
16 | 21 | Signed-off-by: Your Name <[email protected]>
|
17 | 22 | ```
|
18 | 23 |
|
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. |
20 | 26 |
|
21 |
| -``` |
| 27 | +```text |
22 | 28 | git commit --signoff
|
23 | 29 | ```
|
24 | 30 |
|
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 |
26 | 35 |
|
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. |
28 | 48 |
|
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 |
35 | 50 |
|
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]. |
37 | 53 |
|
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