diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7fa4af3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# 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. +- Use the following format: `[PACKAGE](LINK) - DESCRIPTION. ![LANGUAGE]` +- New categories, or improvements to the existing categorization are welcome. +- Keep descriptions short and simple, but descriptive. +- End all descriptions with a full stop/period. +- Check your spelling and grammar. +- Make sure that your suggestion is positioned as the last item category. +- Make sure your text editor is set to remove trailing whitespace. + +#### Deleting + +Typical reasons for deleting project: + +- Doesn't build in the current Xcode +- No updates / no longer works +- Deprecated +- Lacks license + +#### Projects are ineligible if: + +- Lack recent commit +- Not written in English +- README is not clear + +Your contributions are always welcome! Thank you for your suggestions! :smiley: