Skip to content

Latest commit

 

History

History
96 lines (75 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

96 lines (75 loc) · 3.09 KB

Sources

If you have questions about how to use SocketStream, here is a useful sources:

  1. SocketStream.org
  2. Google Group
  3. GitHub
  4. IRC channel #socketstream
  5. Twitter @socketstream

Submitting issues

To submit an issue please use SocketStream issue tracker.

Contributing to Source Code

We would love for you to contribute to SocketStream source code it even better. To disscuss Minor or Major changes please use Google Group or SocketStream issue tracker

Installation Dependencies

Before you can contribute to SocketStream, you need to install or configure the following dependencies on your machine:

Working with source code

git clone [email protected]:<github username>/socketstream.git
  • Go to project repository
cd socketstream
  • Add the main SocketStream repository as an upstream remote to your repository
 git remote add upstream https://github.com/socketstream/socketstream.git
  • Install npm dependencies
npm install
  • Make some code changes and run Grunt tasks to make sure your code passed required tests:
grunt
  • You can also run specific tasks separately, to see all available tasks run:
grunt --help
...
Available tasks
        jshint  Validate files with JSHint. *
     mochaTest  Run node unit tests with Mocha *
       default  Default task which runs all the required subtasks
          test  Test everything

Submitting Your Changes

  • Create and checkout a new branch off the master branch for your changes:
git checkout -b new-stuff-branch master
  • Make sure your changes passed the tests:
grunt
  • Commit your changes with descriptive commit message, please describe what you have done as detailed as possible
git add -A
git commit
  • Push your branch to Github:
git push origin new-stuff-branch

  • Create a pull request

  • Once your patch is reviewed and merged, please delete your branch and pull yours and master changes from the main (upstream - SocketStream) repository:

git push origin :new-stuff-branch
git checkout master
git branch -D new-stuff-branch
git pull --ff upstream master

You are all set! Thank you for your contribution!