Use single format of TODO items within your codebase

[dgroup]

Summary

Key	Value
Rule	TodoFormat
Ruleset	io/github/dgroup/arch4u/pmd/formatting/arch4u-code-style-ruleset.xml
Category	Design
Framework	N/A
Since	0.2.0
Incidents in past at my experience	2+

Why?

Those who works in GitHub may generate Github issues from TODO items using the following action https://github.com/marketplace/actions/todo-to-issue.

/**
 * ...
 * TODO Add REST API endpoint that supports OpenAPI and Web-Flux
 *  We need a way how to generate OpenAPI specifications that supports Web-Flux.
 *  Ensure that ....
 *  labels: enhancement, help wanted
 *  assignees: dgroup
 *  milestone: 2
 *
 * Other javadoc elements
 */
public ResponseEntity<Employee> create(@Valid @RequestBody Employee employee) {
     // ...
}

where

Todo section	Required	Todo content	GitHub issue
Subject	true	Add REST API endpoint that supports OpenAPI and Web-Flux	Add REST API endpoint that supports OpenAPI and Web-Flux
Description	false	We need a way how to generate OpenAPI specifications that supports Web-Flux.Ensure that ....	We need a way how to generate OpenAPI specifications that supports Web-Flux.Ensure that ....
Labels	false	'enhancement', 'help wanted'	The labels from GitHub issues to be assigned to newly created issue
Assignees	false	dgroup	The user to whom this issue will be assigned
Milestone	false	2	The GitHub milestone ID that could show sprint or project iteration where this task is targeted

[dgroup]

PMD can't cover non-java source files, thus no sence in this rule anymore