Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.03 KB

Contributing to this project

Submitting bug reports and feature requests

The LaunchDarkly SDK team monitors the issue tracker in this repository. Bug reports and feature requests specific to this project should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.

Some of this code is used by the LaunchDarkly Go SDK. For issues or requests that are more generally related to the LaunchDarkly Go SDK, rather than specifically for the code in this repository, please use the go-server-sdk repository.

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

This project should be built against the lowest supported Go version as described below.

Bumping the Minimum Go Version

The SDK is tested against three Go versions: the latest, penultimate, and a minimum based on the SDKs usage of Go features.

Whereas the latest and penultimate are updates on a regular cadence to track upstream Go releases, the minimum version may be bumped at the discretion of the SDK maintainers to take advantage of new features.

Invoke the following make command, which will update go.mod, testservice/go.mod, and .github/variables/go-versions.env (pass the desired Go version):

make bump-min-go-version MIN_GO_VERSION=1.18

Building

To build the project without running any tests:

make

To run the linter:

make lint

Testing

To build and run all unit tests:

make test

To run the standardized contract tests that are run against all LaunchDarkly SSE client implementations:

make contract-tests