OpenAPITools / OpenAPITools/openapi-generator
[SUGGESTION][Documentation] Add documentation for contributors on Windows
Open
Nobody has claimed this yet.
Issue: Bug
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
The Git BASH emulator for Windows did not work (easily) for me. I'd like to suggest to add/replace the documentation with the Windows Subsystem for Linux (WSL).
openapi-generator version
Does not apply.
OpenAPI declaration file content or url
Does not apply.
Generation Details
Does not apply.
Steps to reproduce
Does not apply.
Related issues/PRs
None that I am aware of.
Suggest a fix
We can use an alternative method for contributors to work on windows:
- Install WSL with a Linux system (e.g. https://ubuntu.com/wsl)
- Start and log into WSL.
- Install the correct Java version
- Install Maven.
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 by locating the existing contributor or setup documentation and review its Windows guidance alongside the proposed WSL approach. Done means the documentation explains installing WSL, starting and logging into a Linux system, and installing the correct Java version and Maven.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, ubuntu
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100