grpc/grpc-java

Recommended IntelliJ code style settings are out of date

Open

#617 opened on Jul 10, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Java (11,124 stars) (3,742 forks)batch import
help wanted

Description

I downloaded and imported the GoogleStyle code style settings xml, as recommended in Contributing.md. It doesn't seem like this project and its checkstyle are actually conforming to those style settings (which is fine, I like the prevailing gRPC style better!) A few things in particular keep coming up:

  • Import order: GoogleStyle has static imports at the bottom, doesn't separate grpc imports. This is configured in Code Style > Java > Imports > Import Layout.
  • Method argument wrapping: GoogleStyle has method call arguments and declaration parameters on the next line aligned to the opening paren. This is configured in Code Style > Java > Wrapping and Braces > Method declaration parameters > Align when multiline, as well as the same option under Method call arguments.

Contributor guide

Tech stack
java
Domain
developer experience
Issue type
chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
IntelliJ IDEABasic knowledge of Java code style
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Update the IntelliJ code style settings XML file to match the project's actual style, particularly import order and method argument wrapping. Also update the Contributing.md to reflect the current recommended settings. Refer to the existing checkstyle configuration for guidance.