Browse files

add contributing guidelines

this also includes information regarding the new hubot-scripts org for forking
hubot script packages to a single repo (boxen style).
  • Loading branch information...
1 parent b305c65 commit d0b19316e545420863c13571975433016fcd4928 @tombell tombell committed Sep 3, 2013
Showing with 33 additions and 0 deletions.
  1. +33 −0 CONTRIBUTING.md
View
33 CONTRIBUTING.md
@@ -0,0 +1,33 @@
+It's now preferred that if you are able to, you should release your script as
+part of an npm package built for Hubot.
+
+For an example you can take a look at
+https://github.com/hubot-scripts/hubot-example which is an example package that
+you can use to create your own and publish to npm.
+
+We can also fork your Hubot Script Package to the Hubot Scripts organization so
+people can easily find it and file issues and pull requests. More information
+can be found in the https://github.com/hubot-scripts/packages repository.
+
+If you would still prefer to add your script to this repository then please
+follow the guidelines below.
+
+Some things that will increase the chance that your pull request is accepted:
+
+ * Use CoffeeScript [idioms](http://arcturo.github.io/library/coffeescript/04_idioms.html)
+ and [style guide](https://github.com/polarmobile/coffeescript-style-guide)
+ * Update the documentation, the surrounding one, examples elsewhere, guides,
+ whatever is affected by your contribution
+ * Include any information that would be relevant to reproducing bugs, use
+ cases for new features, etc.
+ * Impact on existing usesrs if modifying a script.
+
+Syntax:
+
+ * Two spaces, no tabs.
+ * No trailing whitespace. Blank lines should not have any space.
+ * Prefer `and` and `or` over `&&` and `||`
+ * Prefer single quotes over double quotes unless interpolating strings.
+ * `MyClass.myMethod(my_arg)` not `myMethod( my_arg )` or `myMethod my_arg`.
+ * `a = b` and not `a=b`.
+ * Follow the conventions you see used in the source already.

0 comments on commit d0b1931

Please sign in to comment.