swagger-api / swagger-api/swagger-codegen
Unclear Mac OS installation instructions in README.md file
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The installation instructions are clearer for Windows than for Mac. I can clearly see how to choose between OpenAPI verisons 2 and 3 for windows, but for the Mac, it just gives me a brew command, and doesn't even tell me which version of OpenAPI it delivers. Please clarify what the brew command gives me and how to control the choice.
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
Read the Mac and Windows installation sections in README.md and inspect the referenced brew command. Verify which OpenAPI version the Mac installation provides and how users can choose between versions. Update the instructions to make both the delivered version and version-selection procedure explicit, then compare the two platform sections for consistency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100