Skip to content

Commit fb7994d

Browse files
Add CONTRIBUTING.md and small improvements in README.md.
1 parent 113c31e commit fb7994d

File tree

2 files changed

+42
-8
lines changed

2 files changed

+42
-8
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to cx_Oracle
2+
3+
*Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.*
4+
5+
Pull requests can be made under
6+
[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html)
7+
(OCA).
8+
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.
12+
13+
```
14+
Signed-off-by: Your Name <[email protected]>
15+
```
16+
17+
This can be automatically added to pull requests by committing with:
18+
19+
```
20+
git commit --signoff
21+
````
22+
23+
Only pull requests from committers that can be verified as having
24+
signed the OCA can be accepted.

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Open Source Python/Oracle Utility - cx_Oracle
1+
# Open Source Python/Oracle Utility - cx_Oracle
22

33
cx_Oracle is a Python extension module that enables access to Oracle Database
44
and conforms to the Python database API 2.0 specifications with a considerable
@@ -15,17 +15,25 @@ capabilities.
1515

1616
cx_Oracle is licensed under a BSD license which you can find [here][3].
1717

18+
cx_Oracle has been tested with Python version 2.7, and with versions 3.4 and
19+
higher. You can use cx_Oracle with Oracle 11.2, 12.1 and 12.2 client libraries,
20+
allowing connection to multiple Oracle Database versions. Oracle's standard
21+
client-server version interoperability allows connection to both older and
22+
newer databases, for example Oracle 11.2 client libraries can connect to Oracle
23+
Database 10.2 or later.
24+
1825
Please note that an Oracle client (or server) installation is required in order
1926
to use cx_Oracle. If you do not require the tools that come with a full client
2027
installation, it is recommended to install the [Instant Client][4].
2128
which is far easier to install.
2229

23-
For feedback or patches, contact Anthony Tuininga at
24-
[email protected]. For help or to ask questions, please use the
25-
[mailing list][5].
30+
## Help
31+
32+
Issues and questions can be raised with the cx_Oracle community on
33+
[GitHub][9] or on the [mailing list][5].
2634

2735

28-
#Installation
36+
## Installation
2937

3038
Binaries for some platforms and Oracle versions are available at
3139
[PyPI][6]. If you prefer to build your own you can use this command
@@ -42,10 +50,10 @@ commands instead
4250
This module has been built with Oracle client 11.2, 12.1 and 12.2 on Linux and
4351
Windows. Others have reported success with other platforms such as macOS.
4452

45-
See BUILD.txt for additional information.
53+
See [BUILD.txt][10] for additional information.
4654

4755

48-
#Usage Example
56+
## Usage Example
4957

5058

5159
```python
@@ -77,10 +85,12 @@ samples in the samples directory. You can also look at the scripts in the
7785

7886
[1]: https://www.python.org/dev/peps/pep-0249
7987
[2]: http://cx-oracle.readthedocs.io
80-
[3]: http://cx-oracle.readthedocs.io/en/latest/license.html
88+
[3]: https://github.com/oracle/python-cx_Oracle/blob/master/LICENSE.txt
8189
[4]: http://www.oracle.com/technetwork/database/features/instant-client/index.html
8290
[5]: http://lists.sourceforge.net/lists/listinfo/cx-oracle-users
8391
[6]: https://pypi.python.org/pypi/cx_Oracle
8492
[7]: http://cx-oracletools.sourceforge.net
8593
[8]: http://cx-pyoraclelib.sourceforge.net
94+
[9]: https://github.com/oracle/python-cx_Oracle/issues
95+
[10]: https://github.com/oracle/python-cx_Oracle/blob/master/BUILD.txt
8696

0 commit comments

Comments
 (0)