From 7be7ec98ed00351b9001fd75af8a6c17236c1a2b Mon Sep 17 00:00:00 2001 From: Serhii Londar Date: Tue, 8 Oct 2019 18:44:08 +0300 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9cb8cdb..b42b9a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,19 +7,24 @@ Please ensure your pull request adheres to the following guidelines: - Edit [applications.json](https://github.com/serhii-londar/open-source-mac-os-apps/blob/master/applications.json) instead of [README.md](https://github.com/serhii-londar/open-source-mac-os-apps/blob/master/README.md). - Use the following format: ```json - { - "repo_url" : "Link to repository", - "title" : "Name of application", - "screenshots" : [ - "Screenshot url 1", - "Screenshot url 2" - ], - "short_description" : "Description of repository", - "languages" : [ - "Language name" - ], - "category" : "Application category" - } + { + "short_description": "Description of repository", + "categories": [ + "Application category 1", + "Application category 2" + ], + "repo_url": "Link to repository", + "title": "Name of application", + "icon_url": "URL to application icon", + "screenshots": [ + "Screenshot url 1", + "Screenshot url 2" + ], + "official_site": "Official site link", + "languages": [ + "Language name" + ] + } ``` - New categories, or improvements to the existing categorization are welcome. List of all categories can be found in [categories.json](https://github.com/serhii-londar/open-source-mac-os-apps/blob/master/categories.json). - Keep descriptions short and simple, but descriptive.