[EPIC] Optimisations / Todo

[remcowesterhoud]

Description
This is a list of possible optimisations. They are not worked out yet, some are self explanatory and others might require some research.

Blocking for release:

• Improve javadoc on public interfaces #196
• Set up licensing #171
• Revisit documentation #176
• Inform developer about incidents happening in a test case (possibly marking invalid expressions) #188
• Renames and scope changes #237
• Generify naming of extract methods (sometimes extract.., other times extracting..) #217
• Review compile time dependencies #174
• Flaky test: ProcessEventInspectionsTest.testFindLastProcessInstance #202
• Adjust ColumnFamily implementation to reflect API changes in Zeebe #262

Must for completing OKR:

• Deploy workflow stable branch compatibility #231
• Remove QA test duplication #195
• Run testcontainer tests with JDK8 #287
• Check binary compatibility #275
• Create realistic example test #273
• Use SLF4J instead of System.out to log things #175
• Introduce flatten pom #208

Bugfixes:

• Engine.waitForIdleState() does not work as expected #244

Cleanup:

• Add maven dependency checker plugin #227
• Remove public keyword from test methods #197
• Configure IntelliJ to use identical formatting rules #40
• Modify EngineStateMonitor to use built-in Zeebe functionality #133
• Create UserTask assertions #203
• Use a single gRPC server for both the engine and the control services
• Stream records from the agent to the testcontainer extension #330

[remcowesterhoud]

Closing this epic. The important issues have been resolved. The remaining ones either have an issue or probably won't be done anytime soon.