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

chore: update readme #41

Merged
merged 3 commits into from
Aug 11, 2022
Merged

chore: update readme #41

merged 3 commits into from
Aug 11, 2022

Conversation

benjiro
Copy link
Member

@benjiro benjiro commented Aug 10, 2022

  • Include examples of implmenting hooks and providers
  • Include CONTRIBUTING.md

Signed-off-by: Benjamin Evenson 2031163+benjiro@users.noreply.github.com

- Include examples of implmenting hooks and providers
- Include CONTRIBUTING.md

Signed-off-by: Benjamin Evenson <2031163+benjiro@users.noreply.github.com>
@benjiro benjiro requested a review from beeme1mr August 10, 2022 12:45
@codecov-commenter
Copy link

codecov-commenter commented Aug 10, 2022

Codecov Report

Merging #41 (279737a) into main (d78d448) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #41   +/-   ##
=======================================
  Coverage   99.33%   99.34%           
=======================================
  Files          15       16    +1     
  Lines         303      305    +2     
  Branches       24       25    +1     
=======================================
+ Hits          301      303    +2     
  Partials        2        2           
Impacted Files Coverage Δ
src/OpenFeature.SDK/FeatureProvider.cs 100.00% <0.00%> (ø)
src/OpenFeature.SDK/OpenFeatureClient.cs 99.19% <0.00%> (+<0.01%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

This was referenced Aug 10, 2022
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.

Wow, this is a great start. I'll have to borrow parts of the contributing doc for use in other repos.

CONTRIBUTING.md Outdated
@@ -0,0 +1,107 @@
# Contributing to the OpenFeature project

Our community meetings are held fortnightly on Thursdays at 4pm. Check the [OpenFeature community calendar](https://calendar.google.com/calendar/u/0?cid=MHVhN2kxaGl2NWRoMThiMjd0b2FoNjM2NDRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) for specific dates and for the Zoom meeting links.
Copy link
Member

Choose a reason for hiding this comment

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

This section is already in the readme. I would recommend having it in one place so it doesn't accidently get out of sync.

README.md Outdated Show resolved Hide resolved
README.md Outdated

## License

Apache License 2.0
Copy link
Member

Choose a reason for hiding this comment

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

Could you please link to this the license?

benjiro and others added 2 commits August 11, 2022 08:01
Avoid updates to this in the future, users can refer to calendar linke

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Benjamin Evenson <2031163+benjiro@users.noreply.github.com>
Remove duplicate data

Signed-off-by: Benjamin Evenson <2031163+benjiro@users.noreply.github.com>
@benjiro
Copy link
Member Author

benjiro commented Aug 10, 2022

@beeme1mr Thanks for the review, I've addressed above.

@benjiro benjiro merged commit 73fd72e into main Aug 11, 2022
@beeme1mr beeme1mr deleted the chore/update-readme-doco branch August 11, 2022 13:47
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.

None yet

3 participants