Skip to content

Commit

Permalink
add optional "defunct" property to guide
Browse files Browse the repository at this point in the history
  • Loading branch information
linda-rian committed Jan 25, 2016
1 parent bf9ec30 commit da87987
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@

1. Fork the [Banks DB](https://github.com/Ramoona/banks-db) repository and then clone your fork.
2. Create new JSON file in `banks` folder and name it same as your bank title (lowercase).
3. Fill your JSON with this guide (all properties are required):
* `name`: bank codename in lowercase (same as your file name)
* `prefixes`: array of bank prefixes (each prefix must contain 5 or 6 digits)
* `country`: two letters code of bank country ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))
* `localTitle`: bank title in local language
* `engTitle`: bank title in English
* `url`: link to official bank website
* `color`: bank brand color from official logo or website
3. Fill your JSON with this guide:

Here's an example:
* Required:
* `name`: bank codename in lowercase (same as your file name)
* `prefixes`: array of bank prefixes (each prefix must contain 5 or 6 digits)
* `country`: two letters code of bank country ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))
* `localTitle`: bank title in local language
* `engTitle`: bank title in English
* `url`: link to official bank website
* `color`: bank brand color from official logo or website

* Optional
* `defunct` : set `true` for banks with revoked license

```js
Here's an example:

```js
{
"name": "mybank",
"prefixes": [
Expand Down

0 comments on commit da87987

Please sign in to comment.