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

doc: Changes in README.md file #38825

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

iamvbenz49
Copy link

issue: #38797
Before:
Screenshot from 2024-12-27 18-41-24

There was no inclusion of the embedding function used which will be quite harder for a beginner to understand
After:
Screenshot from 2024-12-27 18-43-37
A sample embedding function

@sre-ci-robot sre-ci-robot added the size/S Denotes a PR that changes 10-29 lines. label Dec 27, 2024
@sre-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: iamvbenz49
To complete the pull request process, please assign yanliang567 after the PR has been reviewed.
You can assign the PR to them by writing /assign @yanliang567 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Contributor

mergify bot commented Dec 27, 2024

@iamvbenz49 Thanks for your contribution. Please submit with DCO, see the contributing guide https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md#developer-certificate-of-origin-dco.

@mergify mergify bot added needs-dco DCO is missing in this pull request. ci-passed labels Dec 27, 2024
Copy link
Contributor

mergify bot commented Dec 27, 2024

@iamvbenz49

Invalid PR Title Format Detected

Your PR submission does not adhere to our required standards. To ensure clarity and consistency, please meet the following criteria:

  1. Title Format: The PR title must begin with one of these prefixes:
  • feat: for introducing a new feature.
  • fix: for bug fixes.
  • enhance: for improvements to existing functionality.
  • test: for add tests to existing functionality.
  • doc: for modifying documentation.
  • auto: for the pull request from bot.
  1. Description Requirement: The PR must include a non-empty description, detailing the changes and their impact.

Required Title Structure:

[Type]: [Description of the PR]

Where Type is one of feat, fix, enhance, test or doc.

Example:

enhance: improve search performance significantly 

Please review and update your PR to comply with these guidelines.

@iamvbenz49 iamvbenz49 changed the title DOCS: Changes in README.md file doc: Changes in README.md file Dec 27, 2024
@iamvbenz49
Copy link
Author

/assign @yanliang567

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci-passed kind/doc needs-dco DCO is missing in this pull request. size/S Denotes a PR that changes 10-29 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants