App-Open-Source-per-iPhone-.../.github/CONTRIBUTING.md

139 lines
3.6 KiB
Markdown

To contribute to`open-source-ios-apps`, update the **contents.json** file (this will generate the README).
## TLDR
A new entry should update **contents.json** with this format:
```js
{
"title": "Name of the app",
"category": "Category name",
"description": "What this app does",
"source": "Link to source, usually GitHub"
}
```
:tada:
## New category
Please [open an issue](https://github.com/dkhamsing/open-source-ios-apps/issues) and contact
@dkhamsing, @kvnbautista or @scribblemaniac.
## Delete app
To delete an app, add the value **archive** to the `tags` field (more [info](https://github.com/dkhamsing/open-source-ios-apps/wiki/Deleting)).
## New app
Adding a `JSON` entry
### New entries go to the end of the file
![add-entry](https://cloud.githubusercontent.com/assets/4723115/15217463/7f8060c6-1810-11e6-97f7-3b555dc78bf9.gif)
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 format below.
### Format
Feel free to cut and paste the snippet below
```js
{
"title": "Name of the app",
"category": "Category name",
"description": "What this app does",
"source": "Link to source, usually GitHub"
}
```
#### Details
`title`, `category`, `description` and `source` are required, the rest is optional.
```js
{
"title": "App name",
"category": ["github", "parse"],
"description": "Describe what this app does",
"source": "https://github.com/user/repo",
"homepage": "https://awesome-url",
"itunes": "https://itunes.apple.com/app/id1234567890",
"lang": "zho",
"stars": 200,
"tags": ["swift"]
}
```
- `category`: Use an approved category from this list https://github.com/dkhamsing/open-source-ios-apps/wiki/Categories
- `category`: An app can belong to more than one category, in that case use a list format in the example above
- `stars`: Number of GitHub stars
- `lang`: App language in the form of ISO 639-2 code https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
- `tags`: List of app attribute tags, use `swift` if the app is written in Swift
- `itunes`: Link to App Store
- No regional restriction: the app should not have a region in the URL (`/gb` below)
- Good: https://itunes.apple.com/app/gorillas/id302275459
- Bad: https://itunes.apple.com/gb/app/gorillas/id302275459
- If the app is only available in a region, the URL should have a region
- Good: https://itunes.apple.com/gb/app/closebox-find-closest-postbox/id556364813
- Bad: https://itunes.apple.com/app/closebox-find-closest-postbox/id556364813
#### Examples
- https://github.com/dkhamsing/open-source-ios-apps/pull/281
- https://github.com/dkhamsing/open-source-ios-apps/pull/281/files
```js
{
"title": "Firefox",
"category": ["browser", "official"],
"description": "Official Firefox app",
"source": "https://github.com/mozilla/firefox-ios",
"itunes": "https://itunes.apple.com/app/firefox-web-browser/id989804926",
"stars": 5641,
"tags": ["swift"]
}
```
```js
{
"title": "VLC",
"category": ["media", "official"],
"description": "Media Player",
"source": "https://github.com/videolan/vlc",
"homepage": "https://www.videolan.org/",
"itunes": "https://itunes.apple.com/app/vlc-for-ios/id650377962",
"stars": 1753
}
```
```js
{
"title": "Simple Reader",
"category": "hacker-news",
"source": "https://github.com/rnystrom/HackerNewsReader",
"itunes": "https://itunes.apple.com/app/simple-reader-free-open-source/id1000995253",
"stars": 182
}
```
Thanks for contributing :tada: