2010-08-25, 06:12 PM
When you guys build a plugin, can you please consider adhering to the following:
1) Names of settings should be prefixed by your plugin name. Example, setting called 'public_key' in a 'api' plugin should be called 'api_plublic_key', just as how you would create a function in the plugin (e.g. 'api_install'). Doing this will help avoid overwriting existing settings or issues with plugin installation.
2) Names of files and images should include the name of your plugin, such as 'api_h1.jpg' unless you are providing the files/images in their own folder, which should then be named according to your plugin as well, such as '\api\h1.jpg'
I know this makes keys in the $mybb->settings aray longer and more to type, but it makes it easier for other developers.
The file/folder name request makes it easier to uninstall and avoid overwriting existing files, unless of course that is specifically what you want to, but that should be rare.
Thanks and I think all plugin developers would appreciate you considering this.
1) Names of settings should be prefixed by your plugin name. Example, setting called 'public_key' in a 'api' plugin should be called 'api_plublic_key', just as how you would create a function in the plugin (e.g. 'api_install'). Doing this will help avoid overwriting existing settings or issues with plugin installation.
2) Names of files and images should include the name of your plugin, such as 'api_h1.jpg' unless you are providing the files/images in their own folder, which should then be named according to your plugin as well, such as '\api\h1.jpg'
I know this makes keys in the $mybb->settings aray longer and more to type, but it makes it easier for other developers.
The file/folder name request makes it easier to uninstall and avoid overwriting existing files, unless of course that is specifically what you want to, but that should be rare.
Thanks and I think all plugin developers would appreciate you considering this.