jMonkeyEngine / jMonkeyEngine/jmonkeyengine

checking Java code style

Open
#1,877 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

buildscript enhancement
Dominant language
Java
Stars
4.3k
Forks
1.2k
Avg merge
4d 7h
Merged PRs (30d)
14

Description

PR #1655 documented this project's preferred Java coding style. The next step would be to add tools that nudge the project toward compliance with that style.

For my own projects, I've begun using Checkstyle. It is highly configurable and integrated nicely into Gradle. That's the tool I recommend.

Here's how I envision the process:

  1. Add a checkstyle configuration file with a handful of modules and <property name="severity" value="warning"/>. Add apply plugin: 'checkstyle' to common.gradle. This could generate warnings for minor style issues like tab characters, unused imports, and trailing whitespace.
  2. Clean up the "master" branch until there are no checkstyle warnings.
  3. Up the severity to "error" so that style issues abort the build.
  4. Further cleanup the "master" branch, adding checkstyle modules as we go.

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

Read PR #1655 for the documented Java coding style, then inspect common.gradle and the existing Gradle build setup. Add the proposed Checkstyle configuration and run the checks to identify warnings. The work is done when the master branch has no warnings for the configured modules and the check can be raised to error severity.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.