|
1 | 1 | <!-- |
2 | 2 |
|
3 | | - Copyright (c) 2000, 2020, Oracle and/or its affiliates. |
| 3 | + Copyright (c) 2000, 2023, Oracle and/or its affiliates. |
4 | 4 |
|
5 | 5 | Licensed under the Universal Permissive License v 1.0 as shown at |
6 | | - http://oss.oracle.com/licenses/upl. |
| 6 | + https://oss.oracle.com/licenses/upl. |
7 | 7 |
|
8 | 8 | --> |
9 | | -# Contributing to Coherence |
| 9 | +# Contributing to this repository |
10 | 10 |
|
11 | | -Oracle welcomes contributions to this repository from anyone. |
| 11 | +We welcome your contributions! There are multiple ways to contribute. |
12 | 12 |
|
13 | | -If you want to submit a pull request to fix a bug or enhance an existing |
14 | | -feature, please first open an issue and link to that issue when you |
15 | | -submit your pull request. |
| 13 | +## Opening issues |
16 | 14 |
|
17 | | -If you have any questions about a possible submission, feel free to open |
18 | | -an issue too. |
| 15 | +For bugs or enhancement requests, please file a GitHub issue unless it's |
| 16 | +security related. When filing a bug remember that the better written the bug is, |
| 17 | +the more likely it is to be fixed. If you think you've found a security |
| 18 | +vulnerability, do not raise a GitHub issue and follow the instructions in our |
| 19 | +[security policy](./SECURITY.md). |
19 | 20 |
|
20 | | -## Contributing to the Oracle Coherence Community Edition repository |
| 21 | +## Contributing code |
21 | 22 |
|
22 | | -Pull requests can be made under |
23 | | -[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA). |
| 23 | +We welcome your code contributions. Before submitting code via a pull request, |
| 24 | +you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and |
| 25 | +your commits need to include the following line using the name and e-mail |
| 26 | +address you used to sign the OCA: |
24 | 27 |
|
25 | | -For pull requests to be accepted, the bottom of your commit message must have |
26 | | -the following line using your name and e-mail address as it appears in the |
27 | | -OCA Signatories list. |
28 | | - |
29 | | -``` |
| 28 | +```text |
30 | 29 | Signed-off-by: Your Name <[email protected]> |
31 | 30 | ``` |
32 | 31 |
|
33 | | -This can be automatically added to pull requests by committing with: |
| 32 | +This can be automatically added to pull requests by committing with `--sign-off` |
| 33 | +or `-s`, e.g. |
34 | 34 |
|
35 | | -``` |
36 | | - git commit --signoff |
| 35 | +```text |
| 36 | +git commit --signoff |
37 | 37 | ``` |
38 | 38 |
|
39 | | -Only pull requests from committers that can be verified as having |
40 | | -signed the OCA can be accepted. |
| 39 | +Only pull requests from committers that can be verified as having signed the OCA |
| 40 | +can be accepted. |
41 | 41 |
|
42 | | -### Pull request process |
| 42 | +## Pull request process |
43 | 43 |
|
44 | | -1. Fork this repository |
| 44 | +1. Ensure there is an issue created to track and discuss the fix or enhancement |
| 45 | + you intend to submit. |
| 46 | +1. Fork this repository. |
45 | 47 | 1. Create a branch in your fork to implement the changes. We recommend using |
46 | | -the issue number as part of your branch name, e.g. `1234-fixes` |
47 | | -1. Ensure that all changes comply to project coding conventions as documented [here](DEV-GUIDELINES.md) |
| 48 | + the issue number as part of your branch name, e.g. `1234-fixes`. |
| 49 | +1. Ensure that any documentation is updated with the changes that are required |
| 50 | + by your change. |
| 51 | +1. Ensure that any samples are updated if the base image has been changed. |
| 52 | +1. Ensure that all changes comply to project coding conventions as documented |
| 53 | + [here](DEV-GUIDELINES.md) |
48 | 54 | 1. Ensure that there is at least one test that would fail without the fix and |
49 | | -passes post fix |
50 | | -1. A full build including test execution is required for the PR |
| 55 | + passes post fix. |
51 | 56 | 1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly |
52 | | -what your changes are meant to do and provide simple steps on how to validate |
53 | | -your changes, ideally referencing the test. Ensure that you reference the issue |
54 | | -you created as well. We will assign the pull request to 2-3 people for review |
55 | | -before it is submitted internally and the PR is closed. |
| 57 | + what your changes are meant to do and provide simple steps on how to validate |
| 58 | + your changes. Ensure that you reference the issue you created as well. |
| 59 | +1. We will assign the pull request to 2-3 people for review before it is submitted |
| 60 | + internally and the PR is closed. |
| 61 | + |
| 62 | +## Code of conduct |
| 63 | + |
| 64 | +Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd |
| 65 | +like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC]. |
56 | 66 |
|
| 67 | +[OCA]: https://oca.opensource.oracle.com |
| 68 | +[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ |
0 commit comments