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

Add link to contributing guidelines

Browse source
This commit is contained in:
Joe Block 2015-05-22 00:38:27 -07:00
parent 1bc5da5786
commit f846517c25
3 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
CONTRIBUTING → Contributing.md
View file

4
README.md
View file

@ -25,7 +25,9 @@
[![Join the chat at https://gitter.im/unixorn/awesome-zsh-plugins](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/unixorn/awesome-zsh-plugins?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/unixorn/awesome-zsh-plugins](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/unixorn/awesome-zsh-plugins?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Collection of ZSH frameworks, plugins, tutorials & themes inspired by the various awesome list collections out there. A collection of ZSH frameworks, plugins, tutorials & themes inspired by the various awesome list collections out there.
*Please read the [Contributing Guidelines](Contributing.md) before contributing.*
## Frameworks ## Frameworks

6
Writing_Plugins.md
View file

@ -1,6 +1,6 @@
# Writing Plugins # Writing Plugins
Try and keep your plugins as cross-framework compatible as possible. Here are some suggestions to make using your plugin as simple as possible, no matter what framework someone is using. Try and keep your plugins as cross-framework compatible as possible. Here are some suggestions to make installing and using your plugin as simple as possible, no matter what framework someone is using.
1. Make using it easier for everyone and put the plugin file at the root level of your plugin repository instead of in a subdirectory. This allows [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users install it with a simple `git clone git@github.com:you/yourplugin.git` in the `custom/plugins` directory and also let [Antigen](https://github.com/zsh-users/antigen) and [zgen](https://github.com/tarjoilija/zgen) users automatically clone the repository without having to specify a subdirectory path. 1. Make using it easier for everyone and put the plugin file at the root level of your plugin repository instead of in a subdirectory. This allows [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users install it with a simple `git clone git@github.com:you/yourplugin.git` in the `custom/plugins` directory and also let [Antigen](https://github.com/zsh-users/antigen) and [zgen](https://github.com/tarjoilija/zgen) users automatically clone the repository without having to specify a subdirectory path.
@ -10,4 +10,6 @@ Try and keep your plugins as cross-framework compatible as possible. Here are so
4. Use `yourplugin.plugin.zsh` for the main plugin file. This is what [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) expects. [Antigen](https://github.com/zsh-users/antigen), [zgen](https://github.com/tarjoilija/zgen) and most other ZSH frameworks will automatically load that filename. 4. Use `yourplugin.plugin.zsh` for the main plugin file. This is what [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) expects. [Antigen](https://github.com/zsh-users/antigen), [zgen](https://github.com/tarjoilija/zgen) and most other ZSH frameworks will automatically load that filename.
5. Submit a PR here so your plugin is easy to find :-) 5. If you’re making a theme, please include a screenshot so prospective users can see what it looks like before they install it.
6. Submit a PR here so your plugin is easy to find :-)