Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.2 KB
Raw

Developing msgpack-swift

Automated Tests

Prerequisites

The MessagePackTests target depends on the MessagePackReferenceImplementation package. That package requires the following software to be available on the system:

Installing Prerequisites on Ubuntu

$ sudo apt install pkg-config libmsgpack-dev

Installing Prerequisites on macOS

$ brew install pkg-config msgpack

Running the Tests Locally

The tests can be run either from an IDE or from the command line.

MessagePackTests Target

Some tests require specific environments:

  • Some tests require the release configuration; otherwise, they would run too slowly.
  • Some tests require a minimum amount of memory to be available.

If the environment is not suitable for a given test, that test will be marked as skipped.

Benchmarks Target

The target should generally be built using the release configuration, though it can also be built using the debug configuration to see the unoptimized performance.