milvus-io/milvus-sdk-go

[Document] Add New Examples to docs/examples

Open

#193 opened on Sep 2, 2021

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Go (113 forks)auto 404
HACKTOBERFESTgood first issuekind/documentation

Repository metrics

Stars
 (367 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there anything that's missing or inappropriate in the docs? Please describe.

More examples are needed for demonstration purposes.

Describe your suggestion

Please submit a pull request and contribute examples to the API reference documents. If you are interested in contributing a complete case example, please add it to the /example folder.

Suggested Step

Please find all API reference doc at https://github.com/milvus-io/milvus-sdk-go/tree/master/docs, /examples folder at https://github.com/milvus-io/milvus-sdk-go/tree/master/examples, and the code at https://github.com/milvus-io/milvus-sdk-go/tree/master/client.

You will need to follow the established practice to add examples.

Should you need any assistance, please feel free to contact us.

Contributor guide

Research direction
Examine existing examples in the /example folder and docs to understand the pattern, then add a new example following that structure.
Tech stack
go
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90