open-source-ios-apps/.github/CONTRIBUTING.md
2016-05-11 07:48:52 -07:00

959 B

To contribute toopen-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 }]

		"stars": 100
	}] // here
}

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

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": "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 🎉