Skip to content
This repository

Massive header docs update #468

Merged
merged 37 commits into from about 2 years ago

4 participants

Tom Bell Josh Nichols Jerad Bitner Steven Hancock
Tom Bell

Reformatting the header comment at the top of each script to simplify and provide useful information for configuring/dependencies.

Preferably refrain for merging in pull requests until this update is finished.

WIP.

Josh Nichols

I started apply this to hubot's src/scripts. After a few, having headings for things that were None seemed like noise. Except maybe description, which probably should be a real description.

Also, a few new headings I encountered needing:

  • URLs: for routing stuff
  • Examples: for examples of commands, when it's not obvious how to use
Tom Bell

I thought about leaving None so services like the hubot-scripts-catalog can easily parse it. When I've finished updating the rest, we can maybe work out what needs adding and what doesn't.

Josh Nichols

Template for copy-pasta into scripts:

# Description:
#   None
#
# Dependencies:
#   None
#
# Configuration:
#   None
#
# Commands:
#   None
#
# Author:
#   None

Also, this may be me being picky, but not a fan of the leading/trailing lines.

Tom Bell

Me either, I was gonna remove them.

Josh Nichols

I was thinking about Configuration, and it probably would be good to have notes about what they are. The aws.coffee had this, and so does wunderlist.coffee which I'm looking at now. I could imagine something like hubot help configuration listing out all these environment variables and what they are for. Those shouldn't show up for hubot help for commands though.

Having 'help commands' be any line with a - can be kind of annoying, especially if you have stuff legitimately hyphenated words. It also means that HUBOT_WUNDERLIST_SMTP_HOST - your smtp host e.g. smtp.gmail.com would match, even if it's not a command. For this case at least, I think we can update hubot to skip over lines that start with HUBOT_.

Tom Bell

Maybe update hubot to read and parse the header comments and store the relevant pieces of info for help stuff.

Tom Bell

Oof. Think that's me done for the night, you fancy finishing off the last few letters?

Josh Nichols

There's just s and t left. Of course, there's 47 between them... I'll see how far I can get on em.

Josh Nichols

Calling it night. Just 's' left now. Give a shout if/when you pick back up on these.

Steven Hancock

Should this None be here? :grin:

None. I mean... Nope. If this is the only one I missed after updating all these comments, then I will be quite pleased.

Not 100% sure.. but I think this is the only one.

Tom Bell

I'll work on 's' today.

Tom Bell

I think we're done!

Jerad Bitner

Wow, great job guys! I just saw this and I'm pretty damn happy about it. :) Reviewing...

Jerad Bitner sirkitree commented on the diff
src/scripts/9gag.coffee
... ... @@ -1,7 +1,18 @@
1   -# hubot 9gag me - Returns a random meme image.
2   -
3   -# Random meme from 9gag
4   -# Rewrite by Enrique Vidal
  1 +# Description:
  2 +# None
2
Jerad Bitner
sirkitree added a note

You could probably put the description here to be "Returns a random meme image", but not a huge deal I think.

Josh Nichols Owner

For scripts that are a single trigger, with the help command being enough to explain it, I almost think Description isn't really necessary. It's just copy-pasta, that doesn't add anything compared to the usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/abstract.coffee
((11 lines not shown))
11   -# Software is furnished to do so, subject to the following
12   -# conditions:
13   -#
14   -# The above copyright notice and this permission notice shall be
15   -# included in all copies or substantial portions of the Software.
16   -#
17   -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18   -# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
19   -# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20   -# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
21   -# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
22   -# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23   -# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24   -# OTHER DEALINGS IN THE SOFTWARE.
  1 +# Description:
  2 +# None
5
Jerad Bitner
sirkitree added a note

Again, here the description could be "Prints a nice abstract of the given topic"

Josh Nichols Owner

It's also a little fuzzy if we should be removing licensing stuff that people add to their scripts. Or, we have to assume they are being made under hubot-script's license, and remove it from all the scripts that have it.

Tom Bell
tombell added a note

When people usually contribute to an open source project the license is usually the one of the actual project. If the license differs to the hubot-scripts license, then people should release the script in it's own package in my opinion.

Jerad Bitner
sirkitree added a note

I have to agree with @tombell here.

It should probably be part of the submission guidelines or something. Are there any actually?

Josh Nichols Owner

Sounds good to me. There isn't a guideline, but there should be. The README is going to be the best place for that, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/achievement_unlocked.coffee
... ... @@ -1,6 +1,18 @@
  1 +# Description:
  2 +# None
1
Jerad Bitner
sirkitree added a note

This could actually use a description, but should probably be a separate issue. i have no idea what the heck this does from reading the header.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/ackbar.coffee
... ... @@ -1,7 +1,17 @@
1   -# It's a trap
  1 +# Description:
  2 +# None
1
Jerad Bitner
sirkitree added a note

Seems there are quite a lot of blank descriptions or the description is in the command. Perhaps a separate pull request once the formatting is at least in place would be warranted instead of pointing them all out here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/auto-stache.coffee
((4 lines not shown))
2 3 #
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
  11 +# None
6
Jerad Bitner
sirkitree added a note

Commands: None? Shouldn't this be required?

Josh Nichols Owner

Not strictly speaking. You can have scripts that are just doing routing stuff, for example. In this case, 'command' isn't really accurate. It's more the things it will hear and respond to, ie URLs with png, jpg, gif.

Tom Bell
tombell added a note

Here the description will suffice, commands imply something you type to trigger it, where as this just detects URLs.

Jerad Bitner
sirkitree added a note

Yeah, I think there are a few that listen for particular things. In this case an image. I wonder if cases here it's more of a listener than a command that we can list that, perhaps in notes? This one is probably explanatory enough within the description.

Tom Bell
tombell added a note

Might be a better option to rename Commands: to Triggers: which will cover everything. Thoughts?

Jerad Bitner
sirkitree added a note

++

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/aws.coffee
((23 lines not shown))
12 14 #
13   -# package.json needs to have "aws2js":"0.6.12" and "moment":"1.6.2" and "underscore":"1.3.3"
  15 +# Commands:
  16 +# hubot sqs status - Returns the status of SQS queues
1
Jerad Bitner
sirkitree added a note

Think we're missing a command here. Looks like the original doc header had two commands.

# hubot sqs status - Returns the status of SQS queues.
# hubot ec2 status - Returns the status of EC2 instances.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/conversation.coffee
... ... @@ -1,4 +1,17 @@
1   -# Extends robot adding conversation features
  1 +# Description:
  2 +# Extends robot adding conversation features
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
  11 +# None
1
Jerad Bitner
sirkitree added a note

Another Commands: None
Perhaps this is another area for a separate issue? "Find all scripts not listing a command and document the command?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/demolition-man.coffee
... ... @@ -1,4 +1,16 @@
1   -# Watch your language!
  1 +# Description:
  2 +# Watch your language!
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/eval.coffee
... ... @@ -1,6 +1,17 @@
1   -# evaluate code.
  1 +# Description:
  2 +# evaluate code
2
Jerad Bitner
sirkitree added a note

LOL - wow, this just sounds like a terrible idea - what the heck are the standards for allowing a script in? Whoa.

Tom Bell
tombell added a note

Eval's code on a web service, not the hubot, so there is no issue really.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/facepalm.coffee
... ... @@ -1,5 +1,16 @@
1   -# Clearly illustrate with an image what people mean whenever
2   -# they say "facepalm".
  1 +# Description:
  2 +# Clearly illustrate with an image what people mean whenever they say "facepalm"
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/file-brain.coffee
... ... @@ -1,8 +1,21 @@
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# FILE_BRAIN_PATH
  9 +#
  10 +# Commands:
  11 +# None
1
Jerad Bitner
sirkitree added a note

Missing command and description docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/flying-high.coffee
... ... @@ -1,3 +1,17 @@
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command and description docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
src/scripts/github-issues.coffee
((4 lines not shown))
2 3 #
3   -# You need to set the following variable:
4   -# HUBOT_GITHUB_TOKEN = "<oauth token>"
  4 +# Dependencies:
  5 +# "underscore": "1.3.3"
  6 +# "underscore": "2.1.1"
2
Jerad Bitner
sirkitree added a note

this relies on 2 versions of underscore? is that even possible?

Tom Bell
tombell added a note

the 2nd one is suppose to be underscore.string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/inigo-montoya.coffee
... ... @@ -1,3 +1,17 @@
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command and description docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/itcrowd.coffee
((7 lines not shown))
5   -
6   -# REQUIRED MODULES
7   -# sudo npm install htmlparser
8   -# sudo npm install soupselect
9   -# sudo npm install jsdom
10   -# sudo npm install underscore
  4 +# Dependencies:
  5 +# "htmlparser": "1.7.6"
  6 +# "soupselect: "0.2.0"
  7 +# "jsdom": "0.2.14"
  8 +# "underscore": "1.3.3"
  9 +#
  10 +# Configuration:
  11 +# None
  12 +#
  13 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/jira.coffee
((10 lines not shown))
8   -# hubot show filter(s) - Show all filters
9   -# hubot show filter <name> - Show a specific filter
10   -
11   -# Required environment variables:
12   -# * HUBOT_JIRA_URL: Base URL to JIRA instance, without trailing slash eg: https://myserver.com/jira
13   -# * HUBOT_JIRA_USER: JIRA username
14   -# * HUBOT_JIRA_PASSWORD: JIRA password
15   -# Optional environment variables:
16   -# * HUBOT_JIRA_USE_V2: "true" to use v2 of the JIRA REST API, defaults to "false" (v1)
17   -# * HUBOT_JIRA_MAXLIST: maximum number of items to show for a JQL query, defaults to 10
18   -# * HUBOT_JIRA_ISSUEDELAY: number of seconds to not show a ticket for again after it's been
19   -# mentioned once. This helps to cut down on noise from the bot.
20   -# Defaults to 30.
21   -# * HUBOT_JIRA_IGNOREUSERS: Comma-seperated list of users to ignore "hearing" issues from.
22   -# This works well with other bots or API calls that post to the room.
23   -# Example: "Subversion,TeamCity,John Doe"
2
Jerad Bitner
sirkitree added a note

There are quite a few of these where the description for keys is removed. IMHO it might be good to keep these somehow. Either as they are (with the config vars) or in the Notes section.

Tom Bell
tombell added a note

Not 100% certain on what the formatting of the help for keys is going to be like, they can be retrofitted once formatting is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/jordan.coffee
... ... @@ -1,5 +1,17 @@
1   -# Display a picture of Michael Jordan if anyone invokes "jordan" or says "23"
2   -# Cause Jordan is God. So much more than Steve Jobs :D
  1 +# Description:
  2 +# Display a picture of Michael Jordan if anyone invokes "jordan" or says "23"
  3 +# Cause Jordan is God. So much more than Steve Jobs :D
  4 +#
  5 +# Dependencies:
  6 +# None
  7 +#
  8 +# Configuration:
  9 +# None
  10 +#
  11 +# Commands:
1
Jerad Bitner
sirkitree added a note

Description says it all, so command doc being blank here might be ok?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/likeaboss.coffee
((4 lines not shown))
2 3 #
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/linsanity.coffee
... ... @@ -1,5 +1,17 @@
1   -# Display a picture of Jeremy Lin if anyone invokes "linsanity" or says "linspire"
2   -# Cause Lin is Linspiring!
  1 +# Description:
  2 +# Display a picture of Jeremy Lin if anyone invokes "linsanity" or
  3 +# says "linspire". Cause Lin is Linspiring!
  4 +#
  5 +# Dependecies:
  6 +# None
  7 +#
  8 +# Configuration:
  9 +# None
  10 +#
  11 +# Commands:
1
Jerad Bitner
sirkitree added a note

Command blank here too, but description says it's more of a listener.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Tom Bell

The commands are basically me not bothering to read a script and work out what everything does, I only added the commands for scripts that already had them documented.

Jerad Bitner sirkitree commented on the diff
src/scripts/myappstatus.coffee
((14 lines not shown))
7 9 # setup http://hostname/hubot/myappstatus/ROOMNUMBER as
8 10 # your notification webook. If on Heroku lookup the hostname where
9 11 # the hubot server is running. (e.g. my-hubot.herokuapp.com)
10 12 #
11   -# Check you are using a recent version of hubot in packages.json
12   -# to ensure the robot.router is available
  13 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing commands doc and nothing says anything about what it keys off of.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/ping.coffee
... ... @@ -1,4 +1,16 @@
1   -# Hubot is very attentive (ping hubot)
  1 +# Description:
  2 +# Hubot is very attentive (ping hubot)
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs. Is 'ping hubot' the command?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/polite.coffee
((4 lines not shown))
2 3 #
3   -# Say thanks to your robot.
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/put-it-back.coffee
... ... @@ -1,4 +1,16 @@
1   -# put back the table
  1 +# Description:
  2 +# put back the table
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
  11 +#
1
Jerad Bitner
sirkitree added a note

Missing command docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/redis-brain.coffee
... ... @@ -1,3 +1,18 @@
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# "redis": "0.7.2"
  6 +#
  7 +# Configuration:
  8 +# REDISTOGO_URL
  9 +#
  10 +# Commands:
  11 +# None
1
Jerad Bitner
sirkitree added a note

Missing command and description docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/sensitive.coffee
... ... @@ -1,4 +1,16 @@
1   -# Hubot has feelings too, you know
  1 +# Description:
  2 +# Hubot has feelings too, you know
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs and desc gives you no clue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/serenity.coffee
... ... @@ -1,4 +1,16 @@
1   -# Serenity Now!!
  1 +# Description:
  2 +# Serenity Now!!
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs and desc gives you no clue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/sigh.coffee
... ... @@ -1,4 +1,16 @@
1   -# http://xkcd.com/1009/
  1 +# Description:
  2 +# http://xkcd.com/1009/
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs and desc gives you no clue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/store-messages-couchdb.coffee
... ... @@ -1,3 +1,18 @@
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# "cradle": "0.6.3"
  6 +#
  7 +# Configuration:
  8 +# HUBOT_COUCHDB_URL
  9 +#
  10 +# Commands:
  11 +# None
1
Jerad Bitner
sirkitree added a note

Missing command docs and desc gives you no clue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/sweetdude.coffee
... ... @@ -1,3 +1,17 @@
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
  11 +#
1
Jerad Bitner
sirkitree added a note

Missing command docs and desc gives you no clue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/tweet-content.coffee
... ... @@ -1,4 +1,17 @@
1   -# detect tweet URL and send tweet content
  1 +# Description:
  2 +# None
  3 +#
  4 +# Dependencies:
  5 +# None
  6 +#
  7 +# Configuration:
  8 +# None
  9 +#
  10 +# Commands:
1
Jerad Bitner
sirkitree added a note

Missing command docs and description (mistakenly?) removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
src/scripts/wikipedia.coffee
((13 lines not shown))
  101 +# copy, modify, merge, publish, distribute, sublicense, and/or sell
  102 +# copies of the Software, and to permit persons to whom the
  103 +# Software is furnished to do so, subject to the following
  104 +# conditions:
  105 +#
  106 +# The above copyright notice and this permission notice shall be
  107 +# included in all copies or substantial portions of the Software.
  108 +#
  109 +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  110 +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  111 +# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  112 +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  113 +# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  114 +# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  115 +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  116 +# OTHER DEALINGS IN THE SOFTWARE.
1
Jerad Bitner
sirkitree added a note

Should this really be in here? Shouldn't any script to be included be part of the overall and only one determined license?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Jerad Bitner sirkitree commented on the diff
src/scripts/xmas.js
((9 lines not shown))
5 6 //
  7 +// Configuration:
  8 +// None
  9 +//
  10 +// Commands:
  11 +// hubot is it xmas ? - returns whether is it christmas or not
  12 +// hubot is it christmas ? - returns whether is it christmas or not
  13 +//
  14 +// Author:
  15 +// Johnny G. Halife
2
Jerad Bitner
sirkitree added a note

Why does this one have different comment notation?

Tom Bell
tombell added a note

It's JavaScript.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Tom Bell
# Description:
#   <description of the script functionality>
#
# Dependencies:
#   "<module-name>": "<module-version>"
#
# Configuration:
#   ENV_VAR_1: <what the environment variable is>
#
# Triggers:
#   <respond/hear trigger> - <description of the functionality for the trigger>
#
# Notes:
#   <optional notes about the script, including finding values for environment variables and setup>
#
# Routes:
#   <GET/PUT/POST/DELETE route> - <description of what the route does>
#
# Author:
#   <author's github username>
Tom Bell

I'm going to give this another once through changing Commands: to Triggers:, then I'm going to merge into master. Anything people disagree with then can be opened in separate issues/pull requests.

Tom Bell tombell merged commit 9b6ec36 into from
Tom Bell tombell closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 37 unique commits by 2 authors.

Jun 08, 2012
Tom Bell tombell Update "a" scripts help comments 0fd9560
Tom Bell tombell Missing dependency version c00598b
Tom Bell tombell Update "b" scripts help comments b10ac8c
Tom Bell tombell Missing dependencies 5a50a89
Tom Bell tombell Update "c" scripts help comments 9b890bd
Tom Bell tombell Update "d" scripts help comments 5be197c
Tom Bell tombell Update "e" scripts help comments 4695f8d
Jun 09, 2012
Tom Bell tombell Update "f" scripts help comments 97660e8
Tom Bell tombell Update "g" scripts help comments 9e098d6
Josh Nichols technicalpickles Update "y" help comments 1ee9923
Josh Nichols technicalpickles Update "x" help comments 6334eeb
Tom Bell tombell Update "h" scripts help comments 50796ea
Tom Bell tombell Update "i" scripts help comments cafa337
Tom Bell tombell Merge branch 'help-update' of github.com:github/hubot-scripts into he…
…lp-update
0f185dc
Tom Bell tombell Update "j" scripts help comments e8b5ec3
Tom Bell tombell Update "k" scripts help comments 706bd95
Tom Bell tombell Update "l" scripts help comments 74894f3
Tom Bell tombell Update "m" scripts help comments 3369f7e
Tom Bell tombell Update "n" scripts help comments 7e12eb7
Tom Bell tombell Update "o" scripts help comments 5f04060
Tom Bell tombell Update "p" scripts help comments 9a259a0
Tom Bell tombell Update "q" scripts help comments 0de8357
Josh Nichols technicalpickles Update "w" help comments 3406d66
Josh Nichols technicalpickles Update "v" help comments 1866872
Tom Bell tombell Update "r" scripts help comments e7eea40
Tom Bell tombell Merge branch 'help-update' of github.com:github/hubot-scripts into he…
…lp-update
1f86fe1
Josh Nichols technicalpickles Update "u" help comments 372727e
Josh Nichols technicalpickles Update "t" help comments f1ae7b7
Josh Nichols technicalpickles Remove inappropriate none 91e9a4d
Tom Bell tombell Update "s" scripts help comments e69f9e9
Tom Bell tombell Trim blank line comments, and fix up issues 2e1951c
Tom Bell tombell Merge branch 'help-update' of github.com:github/hubot-scripts into he…
…lp-update
e1fd3c0
Tom Bell tombell Update README to include section of documentation changes d8a62a3
Jun 10, 2012
Tom Bell tombell Remove non-standard doc comments 33ea9a1
Tom Bell tombell Fix misc issues afd70c0
Jun 12, 2012
Tom Bell tombell Minor README update c7a4185
Jun 24, 2012
Tom Bell tombell Merge branch 'master' into help-update 9b6ec36
Something went wrong with that request. Please try again.