Socket

Socket

Welcome to Socket’s documentation!

TCP socket.

Status

Source Shields
Project release license dependents
Health travis codacy coverage readthedocs
Repository issues pulls
Activity contributors monthly_commits last_commit

Installation

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

To build from source:

make

Tests

To run unit tests:

grunt tests:unit

To generate a coverage report:

grunt tests:coverage

Documentation

This repository's documentation is hosted on readthedocs.

To generate the sphinx configuration:

grunt docs:generate

Then build the documentation:

grunt docs:build

Tooling

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.

Versioning

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

Changelog

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

Contributing

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

Contributors

Buy Me A Coffee

Remarks

Lots of love to the open source community!

Be kind

Be kind


Content


Indices and tables

Table Of Contents