Google Code-in

Checkstyle is an automated tool that helps programmers write cleaner Java code by creating reports about code style violations. Terasology has a few small Checkstyle violations that are usually easy to fix but can sometimes be left unfixed for quite a while. Your task is to help us find and fix these violations.

Requirements

You should be able to run checkstyle through either our command line gradle configuration or through IntelliJ (with our custom rules active)

Acceptance Criteria

• A pull request which reduces the amount of open Checkstyle issues by 15 or more is submitted to either the Terasology engine repo, a module or the Destination Sol repo
  • Not all of these fixes need to be in the same file, but they do need to be in the same repository.

Rejection Criteria

• The code logic was changed (besides the changes required to fix a Checkstyle issue)
  • A new checkstyle issue was introduced (d'oh!)
  • Not enough issues were fixed (remember, at least 15!)

Resources & References (Where to Start)

Prepare your workspace or even run the game from source TODO LINK before starting!

There are two ways to obtain a list of Checkstyle issues:

Use the command ./gradlew checkstyleMain to generate a checkstyle report for each project, then open Terasology/engine/build/reports/checkstyle/main.html. Use the CheckStyle-IDEA plugin for IntelliJ IDEA and run Checkstyle for all projects. From the list of found issues, move to the reported file & line in your workspace and fix the Checkstyle issue!

Note: This is a multi-instance task - other students can pick it too and might end up fixing the same reports. Take a look at pending PRs in the relevant repo before submitting yours; if another student has already fixed some issues in the same classes as you, you may need to change what you're fixing or wait till the earlier work is merged, then adjust what you're adding.