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