ToothlessGear / node-gcm

A NodeJS wrapper library port to send data to Android devices via Google Cloud Messaging
https://github.com/ToothlessGear/node-gcm
Other
1.3k stars 208 forks source link

adding dependencies installation & test run info in contributing #209

Closed chirag200666 closed 8 years ago

chirag200666 commented 8 years ago

I wanted to add a few features, I was struggling to find how to get started with writing code and run the tests, so I created this pull request. Please suggest more things which can help in getting started quickly.

hypesystem commented 8 years ago

This should not be necessary. If you clone and npm install the tests should be available with npm test. If you had trouble figuring out how to run the tests, though, many other people probably did, too.

So how about a section called Development, which tells users how to get started with development? It should probably contain both the clone URL and the correct test command :smile:

chirag200666 commented 8 years ago

Hi @hypesystem, that would be great and having a link of that in Readme will be helpful. Thanks

hypesystem commented 8 years ago

If you make the changes, I will merge it :smile:

chirag200666 commented 8 years ago

@hypesystem can you have a look now.

chirag200666 commented 8 years ago

Should I move the development to README.md or is it fine in the current CONTRIBUTING.md ?

hypesystem commented 8 years ago

I think it is fine in CONTRIBUTING, but you could definitely add a link to the README

hypesystem commented 8 years ago

The only comment I have is that for nicer formatting of the code you could use triple-followed byjs`. See the Github Markdown help

eladnava commented 8 years ago

@chirag200666 I'd suggest moving the "Development" section you added before the "Become a Collaborator!" section. Also, please be sure to link to it in the #contents.

Good job!

hypesystem commented 8 years ago

This looks good to me :)

eladnava commented 8 years ago

@chirag200666 Well done!

chirag200666 commented 8 years ago

thanks @eladnava & @hypesystem :smile: