Skip to content

Commit 1a7df23

Browse files
author
contra
committed
Merge pull request gulpjs#1152 from callumacrae/naming-guidelines
Added plugin naming guidelines
2 parents 88ac4cf + 880152d commit 1a7df23

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/writing-a-plugin/guidelines.md

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
1. Prefix any errors with the name of your plugin
2929
- For example: `gulp-replace: Cannot do regexp replace on a stream`
3030
- Use gulp-util's [PluginError](https://github.com/gulpjs/gulp-util#new-pluginerrorpluginname-message-options) class to make this easy
31+
1. Name your plugin appropriately: it should begin "gulp-" if it is a gulp plugin
32+
- If it is not a gulp plugin, it should not begin "gulp-"
3133
1. The type of `file.contents` should always be the same going out as it was when it came in
3234
- If file.contents is null (non-read) just ignore the file and pass it along
3335
- If file.contents is a Stream and you don't support that just emit an error

0 commit comments

Comments
 (0)