Document the bound domain in provider initialization and domain-scoped providers
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with the existing provider/domain and provider-lifecycle documentation referenced in the issue, using related issues #1387 and #119 for context. Document that initialize can receive the bound domain, when it is useful, and what declaring a domain-scoped provider means. Done when the API's one-domain binding rule and both provider concepts are covered in the existing documentation.
Written by the indexing model from the issue text.
Description
The spec now supplies the bound domain to a provider's initialize function, and adds an opt-in domain-scoped provider declaration that the API enforces by binding such a provider to at most one domain. The conceptual docs should cover this so provider authors and users understand it.
What needs to happen
- Document that
initializecan receive the bounddomain, and when a provider would use it (e.g. scoping a persistent cache) - Document the
domain-scopedprovider concept: what declaring it means, and that the API binds such a provider to at most onedomain - Fit this into the existing provider/domain and provider-lifecycle docs rather than a standalone page
Related
- #1387 (provider lifecycle guidance), #119 (init/shutdown docs)
Links
- Parent issue: https://github.com/open-feature/spec/issues/403
- Spec sections: 1.1 Flag evaluation, 2.4 Initialization
- Dominant language
- TypeScript
- Stars
- 65
- Forks
- 117
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 41
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from open-feature/openfeature.dev
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
open-feature/openfeature.dev#1482 ·
-
good first issue
Difficulty 4/5 3-5 days Newbie friendliness 43/100
open-feature/openfeature.dev#1362 · 4 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
open-feature/openfeature.dev#1357 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
open-feature/openfeature.dev#1315 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
open-feature/openfeature.dev#1300 ·
All issues in open-feature/openfeature.dev
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·