swagger-api / swagger-api/swagger-codegen
[GO] Client API: No usage example in README.md
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Steps to reproduce
- Generate any Go Client API.
- Open its README.md
Suggest a fix/enhancement
Include example of usage, just like Java/Kotlin client SDKs do.
Contributor guide
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 with the generated Go client's README.md and compare it with the usage examples in the Java and Kotlin client SDK READMEs. Identify the template or source that produces the Go README, then confirm the generated documentation includes a usable client example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100