Mirrors/awesome-zsh-plugins
2
0
Fork 0
mirror of https://github.com/unixorn/awesome-zsh-plugins synced 2024-11-22 09:23:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clean up Contributing.md

Browse source
This commit is contained in:
Joe Block 2015-06-04 10:04:47 -07:00
parent 4a9990db6a
commit 106888e496
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
Contributing.md
View file

@ -1,7 +1,19 @@
# Contributing
Please make all framework/plugin/theme/completions entries as a single line per entry. I let the GH markdown formatter take care of line breaks. This makes it easier to keep the entry sections sorted.
First and foremost, thanks for the help, I appreciate all of the contributions, and the awesome-zsh-plugins list wouldn't be nearly as complete without them.
If you're submitting a theme, please try to make sure that the theme repo has a screen shot so that list users can tell what it looks like before installing it.
## To add to the list:
Thanks for the help, I appreciate all of the contributions.
Submit a pull request.
* Descriptions should be clear, concise, and non-promotional
* Descriptions should follow the link, on the same line
* Each entry should be a single line. This makes keeping the sections sorted easier. We let the GitHub formatter handle adding any required line breaks.
* Each item should be limited to one link, and that link should be the first part of the line.
* If you're submitting a theme, please try to make sure that the theme repo has a screen shot so that list users can tell what it looks like before installing it.
* Please make sure all framework, plugin, themes or completions list entries are sorted *alphabetically*.
* The link should be the name of the package or project
## To remove an entry:
Open an issue to discuss why the entry should be removed, and optionally create a PR.