Implementing and maintaining a protocol stack is a lot of work, therefore any help is appreciated, from creating issues, to contributing documentation, fixing issues and adding new features.
Please follow the best-practice contribution guidelines as mentioned below when submitting any changes.
This module has a changelog which is automatically generated based on Git commit messages. This mechanism requires that all commit messages comply with the Conventional Changelog. You can check if your commit messages complies with those guidelines by using:
npm run changelogThis module uses the Google JavaScript Code-Style and enforces it using JSCS as additional linter beneath JSHint. You can test if your changes comply with the code style by executing:
npm run lintTesting is done using Mocha and is separated into two
sets, unit and integration. While unit tries to test on function level,
including synthetic decoding and encoding, the integration tests are using real
recorded data and are only mocking the transport layer.
For both sets, the test-coverage is calculated using Istanbul. Running the tests and calculating the coverage can be done locally by executing:
npm run test
npm run integrationIt is expected that new features or fixes do not negatively impact the test results or the coverage.
The API documentation is generated using JSDoc and relies on in-line JSDoc3 syntax. The documentation can also be built locally by executing:
npm run docsIt is expected that new features or changes are reflected in the documentation as well.