|
1 | | -# Contributing to this repository |
| 1 | +# Contributing to the Oracle Cloud Infrastructure SDK for TypeScript and JavaScript |
2 | 2 |
|
3 | | -We welcome your contributions! There are multiple ways to contribute. |
| 3 | +_Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved._ |
4 | 4 |
|
5 | | -## Opening issues |
| 5 | +Pull requests can be made under |
| 6 | +[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) |
| 7 | +(OCA). |
6 | 8 |
|
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). |
| 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. |
12 | 12 |
|
13 | | -## Contributing code |
14 | | - |
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: |
19 | | - |
20 | | -```text |
| 13 | +``` |
21 | 14 | Signed-off-by: Your Name <you@example.org> |
22 | 15 | ``` |
23 | 16 |
|
24 | | -This can be automatically added to pull requests by committing with `--sign-off` |
25 | | -or `-s`, e.g. |
| 17 | +This can be automatically added to pull requests by committing with: |
26 | 18 |
|
27 | | -```text |
| 19 | +``` |
28 | 20 | git commit --signoff |
29 | 21 | ``` |
30 | 22 |
|
31 | | -Only pull requests from committers that can be verified as having signed the OCA |
32 | | -can be accepted. |
33 | | - |
34 | | -## Pull request process |
35 | | - |
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. |
48 | | - |
49 | | -## Code of conduct |
50 | | - |
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]. |
53 | | - |
54 | | -[OCA]: https://oca.opensource.oracle.com |
55 | | -[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ |
| 23 | +Only pull requests from committers that can be verified as having |
| 24 | +signed the OCA can be accepted. |
0 commit comments