Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.78 KB

Contributing to the LaunchDarkly Server-side SDK for Haskell

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.

Submitting bug reports and feature requests

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.

Submitting pull requests

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.

Build instructions

Prerequisites

The SDK is built using Stack.

Prerequisites

The SDK depends on PCRE and pkgconf. You'll need to make sure these are installed.

If you use Homebrew you can install the necessary packages by running the following command:

brew install pcre pkg-config

Additionally, you can install the haskell-stack package to install Stack via Homebrew.

Building

To build the SDK without running any tests:

stack build

Testing

To build the SDK and run all unit tests:

stack test