mirror of
https://github.com/jlengrand/open-source-mac-os-apps.git
synced 2026-03-10 08:31:19 +00:00
Add Contribution Guidelines
Add Pull Tequest Template
This commit is contained in:
30
.github/Contribution Guidelines.md
vendored
Executable file
30
.github/Contribution Guidelines.md
vendored
Executable file
@@ -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:
|
||||
21
.github/Pull Tequest Template.md
vendored
Executable file
21
.github/Pull Tequest Template.md
vendored
Executable file
@@ -0,0 +1,21 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Project URL
|
||||
<!--- The project URL -->
|
||||
|
||||
## Category
|
||||
<!--- Category in Awesome macOS open source applications where the project will be added -->
|
||||
|
||||
## Description
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Why it should be included to `Awesome macOS open source applications ` (optional)
|
||||
|
||||
## Checklist
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] Only one project/change is in this pull request
|
||||
- [ ] Addition in chronological order (bottom of category)
|
||||
- [ ] Appropriate language icon(s) added if applicable
|
||||
- [ ] Has a commit from less than 2 years ago
|
||||
- [ ] Has a **clear** README in English
|
||||
Reference in New Issue
Block a user