1
0
mirror of https://github.com/agarrharr/awesome-cli-apps synced 2024-11-04 20:28:52 +01:00
awesome-cli-apps/contributing.md
2019-07-25 12:27:27 +02:00

25 lines
1.1 KiB
Markdown

# Contribution Guidelines
Not all tools can be considered. The aim of the list is to provide a concise list of awesome CLI tools and apps. This means that suggested software should:
- Do one thing and do it well
- Have a free and open source license
- Be easy to install
- Be well documented
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.
- Additions should be added to the bottom of the relevant category.
- Use the following format: `[package](link) - Description.`
- New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive.
- Start the description with a capital and end with a full stop/period.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request should have a useful title like `Add app-xyz` and include a link to the app and why it should be included.
- The apps repository is older than 90 days.
Thank you for your suggestions!