Add examples
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 113
- Forks
- 18
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 23
Description
To be more user friendly, it would be useful to add examples to our commands in cobra (https://github.com/spf13/cobra/blob/06b06a9dc9f9f5eba93c552b2532a3da64ef9877/command.go#L65) and in https://pkg.go.dev (https://go.dev/blog/examples).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the command definitions in command.go at the referenced Cobra location, then review Go's examples guidance linked in the issue. Identify how this CLI's commands are documented and add representative examples so they appear in the command help and on pkg.go.dev.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100