Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 3.81 KB

README.md

File metadata and controls

71 lines (55 loc) · 3.81 KB
Raw

OpenFeature Logo

OpenFeature Specification

Roadmap Contributing Slack CII Best Practices

OpenFeature is an open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool or in-house solution.

This repository describes the requirements and expectations for OpenFeature.

Design Principles

The OpenFeature specification must be designed with:

  • compatibility with existing feature flag offerings.
  • simple, understandable APIs.
  • vendor agnosticism.
  • language agnosticism.
  • low/no dependency.
  • extensibility.

SDKs and Client Libraries

The project aims to provide a unified API and SDK feature flag evaluation across popular technology stacks. The OpenFeature SDK provides a mechanism for interfacing with an external evaluation engine in a vendor agnostic way; it does not itself handle the flag evaluation logic.

An up-to-date SDK compatibility overview can be found here.

Tooling

This specification complies with RFC 2119 and seeks to conform to the W3C QA Framework Guidelines.

In accordance with this, some basic tooling (donated graciously by Diego Hurtado) has been employed to parse the specification and output a JSON structure of concise requirements, highlighting the particular RFC 2119 verb in question.

To parse the specification, simply type make. Please review the generated JSON files, which will appear as siblings to any of the markdown files in the /specification folder.

Style Guide

  • Use code blocks for examples.
    • Code blocks should be pseudocode, not any particular language, but should be vaguely "Java-esque".
  • Use conditional requirements for requirements that only apply in particular situations, such as particular languages or runtimes.
  • Use "sentence case" enclosed in ticks (`) when identifying entities outside of code blocks (ie: evaluation details instead of EvaluationDetails).
  • Do not place line breaks into sentences, keep sentences to a single line for easier review.
  • String literals appearing outside of code blocks should be enclosed in both ticks (`) and double-quotes (") (ie: "PARSE_ERROR").
  • Use "Title Case" for all titles.
  • Use the imperative mood and passive voice.