OpenAPITools / OpenAPITools/openapi-generator

[BUG] Adherence to google java style guide

Open
#4,322 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Maybe I'm understanding this wrong, but according to the Guidelines for Contributing, java code should adhere to the Google Java Style Guide.

The most glaring difference is that the style guide defines an indentation of 2 spaces, while most java-sources in this repo use 4 spaces.

Personally I would prefer a tool doing as much formatting and checking as possible. E.g.

prettier SomeClassName.java --print-width=100 --write

Most importantly it is unclear to me, how new code should be formatted.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with CONTRIBUTING.md and compare its Java-formatting guidance with the Google Java Style Guide. Review the proposed prettier SomeClassName.java --print-width=100 --write command and the repository's existing Java sources. Done means the project has a clear, agreed formatting and checking approach for new Java code.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.