From f122efd4229aa7f61506d65c602475905956e37a Mon Sep 17 00:00:00 2001 From: Simon Redfern Date: Mon, 25 Apr 2016 00:06:12 +0200 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d3bec863 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + + +## Hello! + +Thank you for your interest in contributing to the Open Bank Project! + +## Pull requests + +If submitting a pull request please read and sign our [CLA](http://github.com/OpenBankProject/OBP-API/blob/develop/Harmony_Individual_Contributor_Assignment_Agreement.txt) and send it to contact@tesobe.com - We'll send you back a code to include in the comment section of subsequent pull requests. + +Please reference Issue Numbers in your commits. + +## Code comments + +Please comment your code ! :-) Imagine an engineer is trying to fix a production issue: she is working on a tiny screen, via a dodgy mobile Internet connection, in a sandstorm - Your code is fresh in your mind. Your comments could help her! + +## Issues + +If would like to report an issue or suggest any kind of improvement please use Github Issues. + +## Licenses + +Open Bank Project API, API Explorer and Sofi are dual licenced under the AGPL and commercial licenses. Open Bank Project SDKs are licenced under Apache 2 or MIT style licences. + +Please see the NOTICE for each project licence. + +## Setup and Tests + +See the README for instructions on setup and running the tests :-) + +Welcome! \ No newline at end of file