These are a collection of community scripts for Hubot, a chat bot for your company.
Once you have Hubot installed, you can drop new scripts from this repository
right into your generated Hubot installation. Just put them in
the new scripts to the
Any third-party dependencies for scripts need adding your your
otherwise a lot of errors will be thrown during the start up of your hubot. You
can find a list of dependencies for a script in the documentation header at the
top of the script.
Restart your robot, and you're good to go.
All the scripts in this repository are located in
You'll also want to add tests for your script; no one likes untested code. It makes Hubot sad.
Additionally, it's extremely helpful to add TomDoc to the
top of each file. (Check out an example).
We'll pull out the commands from those lines and display them in the generic,
hubot help command.
Please note we're no longer including external dependencies in the
package.json, so should you wish to include them please include the package
name and required version in the TomDoc comments at the top of your script.
We're now requiring all scripts in hubot-scripts to contain a documentation header so people know every thing about the script.
# Description # <description of the scripts functionality> # # Dependencies: # "<module name>": "<module version>" # # Configuration: # LIST_OF_ENV_VARS_TO_SET # # Commands: # hubot <trigger> - <what the respond trigger does> # <trigger> - <what the hear trigger does> # # Notes: # <optional notes required for the script> # # Author: # <github username of the original script author>
If you have nothing to fill in for a section you should include
None in that
section. A script will be required to fill out the documentation before being
merged into the repository.