We're updating the issue view to help you get more done. 

Document naming conventions in the technical documentation and ensure all classes comply with them

Description

In particular:

  1. Use the *Impl suffix for classes implementing an interface from the engine.

  2. Use the Lucene*/Elasticsearch*/Pojo*/Orm* prefix for interface/classes extending an interface/class from the engine and adding backend-specific bits

  3. Use a consistent naming scheme for abstract classes, especially in APIs/SPIs. Guillaume would rather use Abstract*, Yoann would rather use *Base. Let's stick to one.

We may want to add checkstyle rules or JQAssistant constraints if it's easy, but only if it's easy.

Environment

None

Status

Assignee

Yoann Rodière

Reporter

Yoann Rodière

Labels

None

Suitable for new contributors

None

Feedback Requested

None

Components

Fix versions

Priority

Major