OBP-API/CONTRIBUTING.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

# 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.
2016-04-24 21:49:13 +00:00
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!
2018-03-02 10:12:54 +00:00
## Code style
When naming variables use strict camel case e.g. use myUrl not myURL. This is so we can automatically convert from camelCase to snake_case for JSON output.
2016-04-24 21:49:13 +00:00
## Issues
If would like to report an issue or suggest any kind of improvement please use Github Issues.
## Licenses
2018-09-18 08:34:52 +00:00
Open Bank Project API, API Explorer and Sofit are dual licenced under the AGPL and commercial licenses. Open Bank Project SDKs are licenced under Apache 2 or MIT style licences.
2016-04-24 21:49:13 +00:00
Please see the NOTICE for each project licence.
## Setup and Tests
See the README for instructions on setup and running the tests :-)
2016-04-24 21:49:13 +00:00
Welcome!