Page MenuHomePhabricator

Update Code Conventions for Java and Scala
Open, MediumPublic

Description

As a developer I want to have clear coding conventions to have consistent and high quality code. I also want tools (linter, static analyzers, ...) to help me follow those guidelines.

Minimal conventions already exist for Java, put in place by the Discovery team a long time ago and not significantly updated since 2015. They mostly provide a checkstyle configuration, stored on wiki (and thus not easily used as-is).

The Search Platform team has done significant work to improve tooling and conventions on their Java projects. This was done in the form of a Maven parent pom, which is used for all Search Platform Java projects. See the README in that project for an introduction on the various tools and concepts.

Event Timeline

Gehel created this task.Jul 23 2020, 9:03 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 23 2020, 9:03 AM
fdans triaged this task as Medium priority.Aug 3 2020, 4:28 PM