filippodb
/
App-Open-Source-per-iPhone-iPad-Apple-Watch-TV
mirror of https://github.com/dkhamsing/open-source-ios-apps.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[template] Updates 

[ci skip]
This commit is contained in:
dkhamsing 2016-05-11 08:25:14 -07:00
parent 553309fab7
commit 87c4f4903f
2 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/CONTRIBUTING.md vendored
View File

@ -1,12 +1,17 @@
To contribute to`open-source-ios-apps`, please update the **contents.json** file (this will generate the README)
## Add a new project
## New category
Please [open an issue](https://github.com/dkhamsing/open-source-ios-apps/issues) and contact
@dkhamsing, @kvnbautista or @scribblemaniac
## New app
Adding a `JSON` entry
### New entries go to the end of the file
At the end of contents.json, add an entry at `}]`
At the end of **contents.json**, add an entry at `}]`
```js
"stars": 100
@ -14,15 +19,15 @@ At the end of contents.json, add an entry at `}]`
}
```
Insert a comma between `}` and `]` and create a new entry with the following format
Insert a comma between `}` and `]` and create a new entry with the format below.
### Format
### Format
At minimum
```js
{
"title": "MrCode",
"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
@ -33,14 +38,15 @@ Optionally
```js
{
"title": "MrCode",
"category": "github",
"description": "GitHub iPhone app that can cache Markdown content",
"title": "App name",
"category": ["github", "parse"],
"description": "Describe what this app does",
"lang": "zho",
"source": "https://github.com/haolloyin/MrCode",
"source": "https://github.com/user/repo",
"homepage": "https://awesome-url",
"itunes": "https://itunes.apple.com/app/id1234567890",
"tags": ["swift"],
"stars": 200
"stars": 200 // number of GitHub stars
}
```

8
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -2,6 +2,8 @@
**Please do not edit the README, instead make changes to `contents.json` **
<!-- To create a new category, please open an issue (see CONTRIBUTING) -->
<!-- When making an addition: -->
1. [ ] Project URL:
@ -15,28 +17,26 @@
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", "parse"],
"description": "GitHub iPhone app that can cache Markdown content",
"lang": "zho",
"source": "https://github.com/haolloyin/MrCode",
"homepage": "https://awesome-url",
"itunes": "https://itunes.apple.com/app/id1234567890",
"tags": ["swift"],
"stars": 200
}
```
-->