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-25 09:00:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Serhii Londar 2018-12-27 15:51:32 +02:00 committed by GitHub
parent 65257995ed
commit 8e7c1803b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -4,12 +4,25 @@ Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate. - Search previous suggestions before making a new one, as yours may be a duplicate.
- Make an individual pull request for each suggestion. - Make an individual pull request for each suggestion.
- Use the following format: `[PACKAGE](LINK) - DESCRIPTION. ![LANGUAGE_ICON] <details> <summary> Screenshots </summary> <p float="left"> <bt><img src='Screensho1' width="400"/> <bt><img src='Screensho2' width="400"/> </p></details> `. - Edit applications.json instead of README.md.
- Use the following format:
{
"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"
}
- New categories, or improvements to the existing categorization are welcome. - New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive. - Keep descriptions short and simple, but descriptive.
- End all descriptions with a full stop/period. - End all descriptions with a full stop/period.
- Check your spelling and grammar. - Check your spelling and grammar.
- Make sure that your suggestion is positioned as alphabetically in category.
- Make sure your text editor is set to remove trailing whitespace. - Make sure your text editor is set to remove trailing whitespace.
#### Deleting #### Deleting
@ -24,7 +37,6 @@ Typical reasons for deleting a project:
#### Projects are ineligible if: #### Projects are ineligible if:
- Lack recent commit - Lack recent commit
- Not written in English - README is not clear or not written in English
- README is not clear
Your contributions are always welcome! To generate full description for your repository you can use [awesome-mac-os-apps-helper](https://github.com/serhii-londar/awesome-mac-os-apps-helper). Thank you for your suggestions! :smiley: Your contributions are always welcome! Thank you for your suggestions! :smiley: