open-source-mac-os-apps-mirror/CONTRIBUTING.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

2018-03-30 15:56:09 +00:00
# Contribution Guidelines
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Make an individual pull request for each suggestion.
2018-12-27 13:53:38 +00:00
- 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).
2018-12-27 13:51:32 +00:00
- Use the following format:
2018-12-27 13:52:23 +00:00
```json
2019-10-08 15:44:08 +00:00
{
"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"
]
}
2018-12-27 13:52:23 +00:00
```
2018-12-27 13:55:06 +00:00
- 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).
2018-03-30 15:56:09 +00:00
- Keep descriptions short and simple, but descriptive.
- End all descriptions with a full stop/period.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
#### Deleting
2018-10-27 23:32:59 +00:00
Typical reasons for deleting a project:
2018-03-30 15:56:09 +00:00
- Doesn't build in the current Xcode
- No updates / no longer works
- Deprecated
- Lacks license
#### Projects are ineligible if:
- Lack recent commit
2018-12-27 13:51:32 +00:00
- README is not clear or not written in English
2018-03-30 15:56:09 +00:00
2018-12-27 13:51:32 +00:00
Your contributions are always welcome! Thank you for your suggestions! :smiley: