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

Added sample code to readme.md #103

Closed

Conversation

harrowmykel
Copy link
Contributor

Description

This change adds a sample code to readme so that developers can easily get started

Issues Resolved

Closes #27 #46

@dblock
Copy link
Member

dblock commented Nov 15, 2022

We have been writing https://github.com/opensearch-project/opensearch-php/blob/main/USER_GUIDE.md - is this duplicate? Maybe the README needs to be clearer to look there for sample code? I also think sample code should be runnable, or exercised in CI, and we would point to a working code, ideally.

@harrowmykel
Copy link
Contributor Author

Yes, please add the link to the readme.md. I didn't see the sample codes.

Also I have more examples in my sample code. You can add them.

@harrowmykel
Copy link
Contributor Author

I have updated it and added a new commit

@dblock
Copy link
Member

dblock commented Nov 28, 2022

@harrowmykel LGTM, please fix DCO with (git commit -s --amend)?

@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (main@cf91bd8). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #103   +/-   ##
=======================================
  Coverage        ?   26.96%           
  Complexity      ?     1934           
=======================================
  Files           ?      245           
  Lines           ?     5544           
  Branches        ?        0           
=======================================
  Hits            ?     1495           
  Misses          ?     4049           
  Partials        ?        0           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@harrowmykel
Copy link
Contributor Author

Ok. i have done that

@shyim
Copy link
Collaborator

shyim commented Nov 29, 2022

@harrowmykel You have to sign all your commits or squash into one

@harrowmykel harrowmykel deleted the dev/how-to-use branch November 29, 2022 11:06
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.

Add usage guide
5 participants