open-feature / open-feature/spec

Spec styling and consistency issues

Open
#187 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

chore specification
Dominant language
Python
Stars
1.3k
Forks
58
Avg merge
2d 18h
Merged PRs (30d)
2

Description

As mentioned here, there's some consistency issues with the non-normative parts of the spec. It would be great to get a thorough review of this. These proposed fixes are all editorial, not functional.

Examples of ways we can improve:

  • consistent use of monospace to refer to types and glossary terms (adding more glossary terms if necessary)
  • Consistent language examples: some examples are typescript others are java. I think unless the requirement specifically demands a particular language, we use choose one example language, or a consistent pseudo-code. I recommend Java because it's explicit, typed, and generally well-understood.
  • consistent reference to types with spaces and in lower-case as described in the style guide (ex: flag metadata not flagMetadata)
  • consistent links in non-normative text (link anything relevant)
  • Consistent diagrams (I vote we use mermaid for everything). We have diagrams in the provider and hooks sections that are not mermaid.
  • Consistent pluralization: now that there's multiple providers, we need to update some language which implies there's only one. This will impact normative sections, but not in a meaningful or breaking way.

cc @tcarrio

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the non-normative text and the provider and hooks sections linked in the issue, then compare examples, type references, links, diagrams, glossary terms, and pluralization against the style guide. Done means the specification uses consistent editorial conventions throughout, including consistent example language or pseudocode and diagrams.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.