Update CONTRIBUTING.md

This commit is contained in:
Serhii Londar
2019-10-08 18:44:08 +03:00
committed by GitHub
parent 9ece4ca43f
commit 7be7ec98ed

View File

@@ -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). - 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: - Use the following format:
```json ```json
{ {
"repo_url" : "Link to repository", "short_description": "Description of repository",
"title" : "Name of application", "categories": [
"screenshots" : [ "Application category 1",
"Screenshot url 1", "Application category 2"
"Screenshot url 2" ],
], "repo_url": "Link to repository",
"short_description" : "Description of repository", "title": "Name of application",
"languages" : [ "icon_url": "URL to application icon",
"Language name" "screenshots": [
], "Screenshot url 1",
"category" : "Application category" "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). - 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. - Keep descriptions short and simple, but descriptive.