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 library.
The LaunchDarkly SDK team monitors the issue tracker in the library repository. Bug reports and feature requests specific to this library 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.
This library is built with Bundler. To install Bundler, run gem install bundler. You might need sudo to execute the command successfully.
To install the runtime dependencies:
bundle install
To run all unit tests:
bundle exec rspec spec
Documentation is built automatically with YARD for each release. To build the documentation locally:
cd docs
make
The output will appear in docs/build/html.
A special case is the namespace LaunchDarkly::Otel::Impl, and any namespaces within it. Everything under Impl is considered a private implementation detail: all files there are excluded from the generated documentation, and are considered subject to change at any time and not supported for direct use by application developers. We do this because Ruby's scope/visibility system is somewhat limited compared to other languages: a method can be private or protected within a class, but there is no way to make it visible to other classes in the library yet invisible to code outside of the library, and there is similarly no way to hide a class.
So, if there is a class whose existence is entirely an implementation detail, it should be in Impl. Similarly, classes that are not in Impl must not expose any public members that are not meant to be part of the supported public API. This is important because of our guarantee of backward compatibility for all public APIs within a major version: we want to be able to change our implementation details to suit the needs of the code, without worrying about breaking a customer's code. Due to how the language works, we can't actually prevent an application developer from referencing those classes in their code, but this convention makes it clear that such use is discouraged and unsupported.
All classes and public methods outside of LaunchDarkly::Otel::Impl should have documentation comments. These are used to build the API documentation that is published at https://launchdarkly.github.io/ruby-server-sdk-otel/ and https://www.rubydoc.info/gems/launchdarkly-server-sdk-otel. The documentation generator is YARD; see https://yardoc.org/ for the comment format it uses.
Please try to make the style and terminology in documentation comments consistent with other documentation comments in the library. Also, if a class or method is being added that has an equivalent in other libraries, and if we have described it in a consistent away in those other libraries, please reuse the text whenever possible (with adjustments for anything language-specific) rather than writing new text.