Skip to content

Commit

Permalink
[docs] contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardhotchkiss committed Mar 18, 2012
1 parent 9b550c0 commit e46c40b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 16 deletions.
24 changes: 9 additions & 15 deletions README.md
Expand Up @@ -69,21 +69,15 @@ short.generate(URL, function(error, shortURL) {


**Please see** https://github.com/thinkroth/shortUrl **Please see** https://github.com/thinkroth/shortUrl


Pull Requests ## Contribute
=============


* fork 1. Fork
* clone 2. Clone forked repository
* improve 3. Add some sweet code
* pull request 4. Tests still passing? Run tests with `npm test`
* **instant karma!** 5. Add a test if adding a feature

6. Pull Request
## Run Tests (git clone) 7. **Instant Karma!**

``` bash
$ git clone git@github.com:edwardhotchkiss/short.git
$ cd short && npm test
```


## License (MIT) ## License (MIT)


Expand All @@ -92,5 +86,5 @@ Copyright (c) 2011, Edward Hotchkiss.
### Author: [Edward Hotchkiss][0] ### Author: [Edward Hotchkiss][0]
### Contributors: [Kevin Roth][1] ### Contributors: [Kevin Roth][1]


[0]: http://ingklabs.com/ [0]: http://edwardhotchkiss.com/
[1]: http://github.com/thinkroth/ [1]: http://github.com/thinkroth/
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -2,7 +2,7 @@
"name":"short", "name":"short",
"author":"Edward Hotchkiss <edward@edwardhotchkiss.com>", "author":"Edward Hotchkiss <edward@edwardhotchkiss.com>",
"contributors":[ "contributors":[
{ "name": "Edward Hotchkiss", "email": "edward@edwardhotchkiss.com" }, { "name": "Edward Hotchkiss", "email": "edwardhotchkiss@me.com" },
{ "name": "Kevin Roth", "github": "http://github.com/thinkroth" } { "name": "Kevin Roth", "github": "http://github.com/thinkroth" }
], ],
"description":"NodeJS URL Shortener backed by MongooseJS w/ Examples", "description":"NodeJS URL Shortener backed by MongooseJS w/ Examples",
Expand Down

0 comments on commit e46c40b

Please sign in to comment.