|
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 | 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 |
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). |
12 | 12 |
|
13 |
| -## Contributing Code |
| 13 | +## Contributing code |
14 | 14 |
|
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: |
20 | 19 |
|
21 | 20 | ```text
|
22 | 21 | Signed-off-by: Your Name <[email protected]>
|
23 | 22 | ```
|
24 | 23 |
|
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. |
26 | 26 |
|
27 | 27 | ```text
|
28 | 28 | git commit --signoff
|
29 | 29 | ```
|
30 | 30 |
|
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. |
33 | 33 |
|
34 |
| -### Pull request process |
| 34 | +## Pull request process |
35 | 35 |
|
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. |
37 | 39 | 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`. |
39 | 41 | 1. Ensure that any documentation is updated with the changes that are required
|
40 |
| -by your fix. |
| 42 | + by your change. |
41 | 43 | 1. Ensure that any samples are updated if the base image has been changed.
|
42 | 44 | 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. |
46 | 50 |
|
47 |
| -## Code of Conduct |
| 51 | +## Code of conduct |
48 | 52 |
|
49 | 53 | 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/ |
0 commit comments