Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better plugin headers #103

Open
dgw opened this issue May 11, 2017 · 0 comments
Open

Better plugin headers #103

dgw opened this issue May 11, 2017 · 0 comments

Comments

@dgw
Copy link
Collaborator

dgw commented May 11, 2017

As @zigdon brought up in review of #101, Bucket plugins really don't say what they do except by their names.

I don't like Perl's multi-line comments (the only "real" syntax I've found is =for comment [... lines go here, no indents supported ...] =cut, but I'd be happy to be shown alternatives.

Meanwhile, starting plugins with # BUCKET PLUGIN is currently the only requirement. Below that, a block of single-line comments describing the plugin's function would be nice to have. For example (extra-short lines used for illustration):

# BUCKET PLUGIN

# haiku:
# This Bucket plugin detects haikus in chat
# (lines of 5, 7, and 5 syllables) and saves them
# in a factoid named "Automatic Haiku".

sub route {  # [... plugin code continues]

The description block might also include metadata like plugin author, version number, and so on—but let's start with just a description of what the plugin does. Once we figure out what is wanted, I'll open a PR and start writing descriptions for the existing plugins in the repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant