Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comprehensive and consistent readme #100

Closed
Tracked by #2
toddbaert opened this issue Apr 18, 2023 · 0 comments · Fixed by #130
Closed
Tracked by #2

Add comprehensive and consistent readme #100

toddbaert opened this issue Apr 18, 2023 · 0 comments · Fixed by #130
Labels
1.0-release Required for a 1.0 release good first issue Good for newcomers

Comments

@toddbaert
Copy link
Member

toddbaert commented Apr 18, 2023

Update readme to be consistent with the template here: https://github.com/open-feature/.github/tree/main/templates/READMEs

Definition of done:

  • README structure matches template
  • Examples are up-to-date and added for all TODOs in template
  • details only pertaining to developers of the SDK are moved to CONTRIBUTING.md

See similar Java PR: open-feature/java-sdk#382

@toddbaert toddbaert mentioned this issue Apr 18, 2023
14 tasks
@toddbaert toddbaert changed the title comprehensive readme Add comprehensive and consistent readme Apr 18, 2023
@toddbaert toddbaert added 1.0-release Required for a 1.0 release good first issue Good for newcomers labels Apr 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0-release Required for a 1.0 release good first issue Good for newcomers
Projects
None yet
1 participant