Socket¶

Welcome to Socket’s documentation!

TCP socket.

Status

git clone https://github.com/JoelLefkowitz/socket

To build from source:

make

To run unit tests:

grunt tests:unit

To generate a coverage report:

grunt tests:coverage

This repository's documentation is hosted on readthedocs.

To generate the sphinx configuration:

grunt docs:generate

Then build the documentation:

grunt docs:build

To run linters:

grunt lint

To run formatters:

grunt format

Before commiting new code:

grunt precommit

This will run linters, formaters, generate a test coverage report and the sphinx configuration.

This repository adheres to semantic versioning standards. For more inforamtion on semantic versioning visit SemVer.

Bump2version is used to version and tag changes. For example:

bump2version patch

Please read this repository's CHANGELOG for details on changes that have been made.

Please read this repository's guidelines on CONTRIBUTING for details on our code of conduct and the process for submitting pull requests.

Lots of love to the open source community!

Be kind