1
0
mirror of https://github.com/agarrharr/awesome-cli-apps synced 2024-06-01 19:08:06 +02:00
awesome-cli-apps/contributing.md
2018-12-12 11:45:32 -07:00

32 lines
1.4 KiB
Markdown

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Contribution Guidelines](#contribution-guidelines)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# 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 and include a link to the App and why it should be included.
Thank you for your suggestions!