Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[docs] contribute

  • Loading branch information...
commit e46c40bc931465c575b486b78486063602174191 1 parent 9b550c0
Edward Hotchkiss authored
Showing with 10 additions and 16 deletions.
  1. +9 −15 README.md
  2. +1 −1  package.json
24 README.md
View
@@ -69,21 +69,15 @@ short.generate(URL, function(error, shortURL) {
**Please see** https://github.com/thinkroth/shortUrl
-Pull Requests
-=============
+## Contribute
- * fork
- * clone
- * improve
- * pull request
- * **instant karma!**
-
-## Run Tests (git clone)
-
-``` bash
-$ git clone git@github.com:edwardhotchkiss/short.git
-$ cd short && npm test
-```
+ 1. Fork
+ 2. Clone forked repository
+ 3. Add some sweet code
+ 4. Tests still passing? Run tests with `npm test`
+ 5. Add a test if adding a feature
+ 6. Pull Request
+ 7. **Instant Karma!**
## License (MIT)
@@ -92,5 +86,5 @@ Copyright (c) 2011, Edward Hotchkiss.
### Author: [Edward Hotchkiss][0]
### Contributors: [Kevin Roth][1]
-[0]: http://ingklabs.com/
+[0]: http://edwardhotchkiss.com/
[1]: http://github.com/thinkroth/
2  package.json
View
@@ -2,7 +2,7 @@
"name":"short",
"author":"Edward Hotchkiss <edward@edwardhotchkiss.com>",
"contributors":[
- { "name": "Edward Hotchkiss", "email": "edward@edwardhotchkiss.com" },
+ { "name": "Edward Hotchkiss", "email": "edwardhotchkiss@me.com" },
{ "name": "Kevin Roth", "github": "http://github.com/thinkroth" }
],
"description":"NodeJS URL Shortener backed by MongooseJS w/ Examples",
Please sign in to comment.
Something went wrong with that request. Please try again.