1
0
mirror of https://github.com/dkhamsing/open-source-ios-apps.git synced 2024-12-22 21:38:44 +01:00

[contributing] Create

This commit is contained in:
dkhamsing 2016-05-11 07:22:01 -07:00
parent 3c18d4d911
commit 760afceba7

47
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,47 @@
To contribute to`open-source-ios-apps`, please update the **contents.json** file (this will generate the README)
## Add a new project
Adding a `JSON` entry
### New entries go to the end of the file
At the end of contents.json, add an entry at `}]`
```js
"stars": 100
}] // here
}
```
Insert a comma between `}` and `]` and create a new entry with the following format
### Format
At minimum
```js
{
"title": "MrCode",
"category": "github",
"description": "GitHub iPhone app that can cache Markdown content",
"source": "https://github.com/haolloyin/MrCode" // note, no comma on last line
}
```
Optionally
```js
{
"title": "MrCode",
"category": "github",
"description": "GitHub iPhone app that can cache Markdown content",
"lang": "zho",
"source": "https://github.com/haolloyin/MrCode",
"itunes": "https://itunes.apple.com/app/id1234567890",
"tags": ["swift"],
"stars": 200
}
```
Thanks for contributing :tada: