open-source-ios-apps/.github/CONTRIBUTING.md
dkhamsing 87c4f4903f [template] Updates
[ci skip]
2016-05-11 08:55:48 -07:00

1.1 KiB

To contribute toopen-source-ios-apps, please update the contents.json file (this will generate the README)

New category

Please open an issue 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 }]

		"stars": 100
	}] // here
}

Insert a comma between } and ] and create a new entry with the format below.

Format

At minimum

  {
		"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

  {
		"title": "App name",
		"category": ["github", "parse"],
		"description": "Describe what this app does",
		"lang": "zho",
		"source": "https://github.com/user/repo",
		"homepage": "https://awesome-url",
		"itunes": "https://itunes.apple.com/app/id1234567890",
		"tags": ["swift"],
		"stars": 200 // number of GitHub stars
  }

Thanks for contributing 🎉