beenull/open-source-mac-os-apps-mirror
1
0
Fork 0
mirror of https://github.com/serhii-londar/open-source-mac-os-apps.git synced 2024-11-23 08:00:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Serhii Londar 2019-10-08 18:44:08 +03:00 committed by GitHub
parent 9ece4ca43f
commit 7be7ec98ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
CONTRIBUTING.md
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).
- 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.