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

docs: Update README to match OpenFeature template #147

Merged
merged 5 commits into from
Aug 8, 2024
Merged

Conversation

maxveldink
Copy link
Member

@maxveldink maxveldink commented Aug 7, 2024

This PR

  • adds a basic CONTRIBUTING.md file
  • updates README.md to match OF template and be parseable by release-please

Related Issues

Closes #120
Closes #45

Follow-up Tasks

  • Once this is released, will open a PR to have the ruby-sdk listed on the OF website

@maxveldink maxveldink requested a review from a team as a code owner August 7, 2024 10:44
Copy link

codecov bot commented Aug 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.54%. Comparing base (e4dcb04) to head (9e155c2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #147   +/-   ##
=======================================
  Coverage   99.54%   99.54%           
=======================================
  Files          16       16           
  Lines         218      218           
=======================================
  Hits          217      217           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@maxveldink maxveldink changed the title Update README to match OpenFeature template docs: Update README to match OpenFeature template Aug 7, 2024
@open-feature open-feature deleted a comment from github-actions bot Aug 7, 2024
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start, thanks! The only issue I noticed was CII best practices link goes to the Go SDK.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
beeme1mr
beeme1mr previously approved these changes Aug 7, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@beeme1mr beeme1mr merged commit 27b2dab into main Aug 8, 2024
17 checks passed
@beeme1mr beeme1mr deleted the mv/update-readme branch August 8, 2024 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README to match template Ruby SDK
3 participants