From 88a295aee82595ce03b97126a232d315562688d8 Mon Sep 17 00:00:00 2001 From: Eric Nielsen Date: Mon, 16 Dec 2019 19:36:07 -0500 Subject: [PATCH] Add advise about fpath to Writing_Plugins.md All files in the fpath directories should be able to be compiled. See http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Recompiling-Functions This allows ZSH to take advantage of compiled function digest files. See http://zsh.sourceforge.net/Doc/Release/Functions.html#Autoloading-Functions --- Writing_Plugins.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Writing_Plugins.md b/Writing_Plugins.md index c365b6a..2123ecc 100644 --- a/Writing_Plugins.md +++ b/Writing_Plugins.md @@ -12,6 +12,8 @@ Try and keep your plugins as cross-framework compatible as possible. Here are so 5. If you’re making a theme, please include a screenshot so prospective users can see what it looks like without having to install it. +6. If your plugin adds any of its subdirectories to the `fpath`, make sure those subdirectories only contain function definition files. This allows for frameworks to correctly [zcompile all functions](http://zsh.sourceforge.net/Doc/Release/Functions.html#Autoloading-Functions). Don't make your plugin add its root directory to the `fpath`. + 6. Don't forget to add a license. [choosealicense.com](https://choosealicense.com) is a good tool to help you pick one. 7. Submit a PR here so your plugin is easy to find :-)