docs: Add an OpenFeature feature matrix to the README - #30
Open
kinyoklion wants to merge 1 commit into
Open
Conversation
Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
@cursor review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a feature matrix to the README, mirroring the OpenFeature PHP SDK's own matrix, so a reader can see at a glance what this provider does and does not do.
Implementation details
Rows and statuses were checked against the OpenFeature PHP SDK 2.3.0 and the LaunchDarkly PHP SDK 6.8.3 rather than copied from another provider:
OpenFeature\interfaces\provider\Providerdeclares only the fiveresolve*Valuemethods plus hooks, logger and metadata accessors,ProviderAwareholds a single provider for the whole API, and neitherEvaluationDetailsnorResolutionDetailscarries flag metadata.The three separate fixes opened alongside this (#27, #28, #29) are provider-side bugs within rows the matrix marks as supported, so they do not change any status here.
Requirements
Related issues
None.
Describe the solution you've provided
A
## Feature matrixsection after the supported-versions section, with the sameStatus | Feature | Notesshape as the other LaunchDarkly OpenFeature providers.Describe alternatives you've considered
Listing only the rows the OpenFeature PHP SDK's own matrix has: it would drop initialization, tracking, transaction context and flag metadata, which are exactly the rows readers coming from another LaunchDarkly provider will look for.
Additional context
Testing: documentation only;
make checkstill passes.Link to Devin session: https://app.devin.ai/sessions/38a6eaf69fcf41109e136a1d0fe5e899
Open in Devin Desktop: https://app.devin.ai/desktop/session/38a6eaf69fcf41109e136a1d0fe5e899?variant=devin
Requested by: @kinyoklion
Note
Overview
Adds a Feature matrix section to the README (after supported PHP versions), aligned with the OpenFeature PHP SDK feature list and the same table shape used on other LaunchDarkly OpenFeature providers.
The table lists each capability with ✅/❌ status and notes: supported areas (flag types, targeting, hooks, logging, MultiProvider, extending via
LDClient) and unsupported rows that call out whether the gap is the OpenFeature PHP SDK (e.g. named clients, eventing, shutdown, tracking, transaction context, flag metadata) versus provider behavior.Reviewed by Cursor Bugbot for commit da8803a. Bugbot is set up for automated code reviews on this repo. Configure here.