Skip to content

Commit cca39b0

Browse files
spavlusievaLesiaChaban
authored andcommitted
Update CONTRIBUTING.md
1 parent 1f25826 commit cca39b0

File tree

1 file changed

+46
-13
lines changed

1 file changed

+46
-13
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,59 @@
11
# Contributing to the Oracle Cloud Infrastructure Java SDK
22

3-
*Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
3+
*Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved.
44
This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl
55
or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.*
66

7-
Pull requests can be made under
8-
[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html)
9-
(OCA).
7+
We welcome your contributions! There are multiple ways to contribute.
108

11-
For pull requests to be accepted, the bottom of
12-
your commit message must have the following line using your name and
13-
e-mail address as it appears in the OCA Signatories list.
9+
## Opening issues
1410

15-
```
11+
For bugs or enhancement requests, please file a GitHub issue unless it's
12+
security related. When filing a bug remember that the better written the bug is,
13+
the more likely it is to be fixed. If you think you've found a security
14+
vulnerability, do not raise a GitHub issue and follow the instructions in our
15+
[security policy](./SECURITY.md).
16+
17+
## Contributing code
18+
19+
We welcome your code contributions. Before submitting code via a pull request,
20+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
21+
your commits need to include the following line using the name and e-mail
22+
address you used to sign the OCA:
23+
24+
```text
1625
Signed-off-by: Your Name <you@example.org>
1726
```
1827

19-
This can be automatically added to pull requests by committing with:
28+
This can be automatically added to pull requests by committing with `--sign-off`
29+
or `-s`, e.g.
2030

21-
```
31+
```text
2232
git commit --signoff
23-
````
33+
```
34+
35+
Only pull requests from committers that can be verified as having signed the OCA
36+
can be accepted.
37+
38+
## Pull request process
39+
40+
1. Ensure there is an issue created to track and discuss the fix or enhancement
41+
you intend to submit.
42+
1. Fork this repository.
43+
1. Create a branch in your fork to implement the changes. We recommend using
44+
the issue number as part of your branch name, e.g. `1234-fixes`.
45+
1. Ensure that any documentation is updated with the changes that are required
46+
by your change.
47+
1. Ensure that any samples are updated if the base image has been changed.
48+
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
49+
what your changes are meant to do and provide simple steps on how to validate.
50+
your changes. Ensure that you reference the issue you created as well.
51+
1. We will assign the pull request to 2-3 people for review before it is merged.
52+
53+
## Code of conduct
54+
55+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
56+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
2457

25-
Only pull requests from committers that can be verified as having
26-
signed the OCA can be accepted.
58+
[OCA]: https://oca.opensource.oracle.com
59+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

0 commit comments

Comments
 (0)