S19: establish engineering repository
This commit is contained in:
19
resources/docs/backend-review.md
Normal file
19
resources/docs/backend-review.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Backend review companion
|
||||
|
||||
Use alongside `generated/skills/code-review/SKILL.md` and `generated/CODING_STANDARDS.md`.
|
||||
|
||||
Review changed code for intent-revealing comments, missing public-contract Javadoc,
|
||||
appropriate record use, defensive copying of mutable record components, and
|
||||
compatibility with APIs, JSON and persistence. Assess ambiguous `var` initializers
|
||||
and framework/lifecycle exceptions to field finality. Confirm architecture and
|
||||
injection decisions make sense for production and tests. Check NIO API preference,
|
||||
varargs for trailing array parameters, and Java 25 IO use for direct console
|
||||
input/output; retain System.err for diagnostics. Require Javadoc for public
|
||||
classes and methods beyond basic POJO/data-carrier behavior.
|
||||
|
||||
Read standards reports even when verification passes. Assess every review signal
|
||||
in changed code, including fan-out, public methods and record component counts.
|
||||
Record a rationale for retained signals in application validation evidence or the change description.
|
||||
Check narrowly scoped waivers against recorded maintainer agreement and reason.
|
||||
Never introduce blanket exclusions or weaken thresholds to pass a build.
|
||||
Do not repeat mechanical checks already enforced by tooling; verify their result.
|
||||
Reference in New Issue
Block a user