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