LaunchDarkly has published an SDK contributor's guide that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
The LaunchDarkly SDK team monitors the issue tracker in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
The project uses Composer for managing dependencies.
From the project root directory:
composer install
To run all unit tests:
./vendor/bin/phpunit
# Or, as a shortcut in Linux:
make testIt is preferable to run tests against all supported minor versions of PHP (as described in README.md under Requirements), or at least the lowest and highest versions, prior to submitting a pull request. However, LaunchDarkly's CI tests will run automatically against all supported versions.
By default, this test suite does not include any integration test that relies on external dependencies. To include them, set the environment variable LD_INCLUDE_INTEGRATION_TESTS=1 before running the tests. Note that you will also need an instance of WireMock for the tests to connect to. This can be run via docker as follows:
docker run --rm -p 8080:8080 wiremock/wiremock
To run the SDK contract test suite in Linux (see test-service/README.md):
make contract-testsTo run the Psalm linter and cs-check:
./vendor/bin/psalm --no-cache
composer cs-check
# Or, as a shortcut in Linux:
make lint