Contributing

Contributing

Introduction

Contributing is the best way to improve a open source project and Github makes it really easy to get started. Small introduction to the layout of Socket.IO, it's divided in to two projects:

1. The Socket.IO server for Node.js
2. The Socket.IO client for browsers

The Socket.IO server and the Socket.IO client communicate with each other using the Socket.IO protocol specification which is a light weight way of instructions over the established connection.

There are different ways of contributing to the Socket.IO project.

1. Report bugs for the Socket.IO client or Socket.IO server.
2. Create patches for the reported bugs
3. Improve the performance, memory usage etc.
4. Write wiki pages, like this one.
5. Helping people to get started with Socket.IO and hang out in our irc channel (irc.freenode.net #socket.io).

Reporting

If you have found a issue you can report it in our issue trackers, for server related issues you can report them at socket.io/issues and the client bugs can be reported at socket-io-client/issues.

A good bug report should contain the following information. This will help us with finding and fixing the bug. When you report a bug always make sure it's reproducible with the latest stable version of Socket.IO. And if it's not reported before (there is a search box above the issues list).

Socket.IO help full information

1. Description of the bug.
2. Create a reproducible or failing test case (preferred) or write down the steps.
3. Make sure you test or steps only includes Socket.IO related code and does not depend on third party modules.
4. Report the Node.js version
5. If the bug is related to a transport method make sure that you tell us which transport method should be used.
6. Are you using Socket.IO cross port / cross domain.

Socket.IO Client

1. Description of the bug.
2. Create a reproducible or failing test case (preferred) or write down the steps.
3. Make sure you test or steps only includes Socket.IO related code and does not depend on third party client code.
4. Report the browser version, operating system, service packs.
5. If the bug is related to a transport method make sure that you tell us which transport method should be used.
6. Are you using Socket.IO cross port / cross domain.