jMonkeyEngine / jMonkeyEngine/jmonkeyengine
checking Java code style
Nobody has claimed this yet.
- 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:
- Add a checkstyle configuration file with a handful of modules and
<property name="severity" value="warning"/>. Addapply plugin: 'checkstyle'to common.gradle. This could generate warnings for minor style issues like tab characters, unused imports, and trailing whitespace. - Clean up the "master" branch until there are no checkstyle warnings.
- Up the severity to "error" so that style issues abort the build.
- Further cleanup the "master" branch, adding checkstyle modules as we go.
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 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