From 14e91813d165b9049d1af4b7aa22caf8e90215c8 Mon Sep 17 00:00:00 2001 From: Anthony Tuininga Date: Thu, 9 Mar 2017 19:07:32 -0700 Subject: [PATCH] Add CONTRIBUTING.md and help section in README.md. --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ README.md | 14 ++++++++------ 2 files changed, 32 insertions(+), 6 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cfdfb90 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to cx_Oracle + +*Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.* + +Pull requests can be made under +[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) +(OCA). + +For pull requests to be accepted into cx_Oracle, the bottom of +your commit message must have the following line using your name and +e-mail address as it appears in the OCA Signatories list. + +``` +Signed-off-by: Your Name +``` + +This can be automatically added to pull requests by committing with: + +``` +git commit --signoff +```` + +Only pull requests from committers that can be verified as having +signed the OCA can be accepted. diff --git a/README.md b/README.md index 1d2842a..2b2b9c2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#Open Source Python/Oracle Utility - cx_Oracle +# Open Source Python/Oracle Utility - cx_Oracle cx_Oracle is a Python extension module that enables access to Oracle Database and conforms to the Python database API 2.0 specifications with a considerable @@ -20,12 +20,13 @@ to use cx_Oracle. If you do not require the tools that come with a full client installation, it is recommended to install the [Instant Client][4]. which is far easier to install. -For feedback or patches, contact Anthony Tuininga at -anthony.tuininga@gmail.com. For help or to ask questions, please use the -[mailing list][5]. +## Help + +Issues and questions can be raised with the cx_Oracle community on +[GitHub][9] or on the [mailing list][5]. -#Installation +## Installation Binaries for some platforms and Oracle versions are available at [PyPI][6]. If you prefer to build your own you can use this command @@ -45,7 +46,7 @@ Windows. Others have reported success with other platforms such as macOS. See BUILD.txt for additional information. -#Usage Example +## Usage Example ```python @@ -83,4 +84,5 @@ samples in the samples directory. You can also look at the scripts in the [6]: https://pypi.python.org/pypi/cx_Oracle [7]: http://cx-oracletools.sourceforge.net [8]: http://cx-pyoraclelib.sourceforge.net +[9]: https://github.com/oracle/python-cx_Oracle/issues