docs(reviewer): add 7 external audit documents (test/error, API/perf, CGAL, numerical, input, thread-safety, dependency, math/citation) #35

user2595 · 2026-05-31T08:21:44Z

user2595 commented

2026-05-31 08:21:44 +00:00

This PR adds seven external review documents under doc/reviewer/, each self-contained and actionable by a fresh session (file:line, code snippets, fixes, acceptance criteria):

test-coverage-error-handling-audit — coverage gaps + error handling (gate 80/70/90)
api-performance-audit — API naming (A1–A5, decided) + Newton-solver performance
cgal-submission-readiness-audit — G0 porting-rights blocker, license, layout, manual, tests
numerical-stability-audit — tolerance hierarchy, FD-step vs Newton tol, cancellation, magic constants
input-validation-audit — malformed JSON/XML, NaN/Inf vertex coords
thread-safety-audit — no static state (good); same-mesh concurrency contract
dependency-license-audit — license matrix predicated on the G0-undermined MIT premise; test-mesh provenance
math-derivation-citation-audit — Kolpakov-Mednykh missing ref, BPS 2010-vs-2015, preprint verification

Docs-only; no code changes. The headline cross-cutting blocker (referenced from 3 audits) is G0: clarify porting rights with the Varylab/TU-Berlin authors.

This PR adds seven external review documents under `doc/reviewer/`, each self-contained and actionable by a fresh session (file:line, code snippets, fixes, acceptance criteria): - **test-coverage-error-handling-audit** — coverage gaps + error handling (gate 80/70/90) - **api-performance-audit** — API naming (A1–A5, decided) + Newton-solver performance - **cgal-submission-readiness-audit** — G0 porting-rights blocker, license, layout, manual, tests - **numerical-stability-audit** — tolerance hierarchy, FD-step vs Newton tol, cancellation, magic constants - **input-validation-audit** — malformed JSON/XML, NaN/Inf vertex coords - **thread-safety-audit** — no static state (good); same-mesh concurrency contract - **dependency-license-audit** — license matrix predicated on the G0-undermined MIT premise; test-mesh provenance - **math-derivation-citation-audit** — Kolpakov-Mednykh missing ref, BPS 2010-vs-2015, preprint verification Docs-only; no code changes. The headline cross-cutting blocker (referenced from 3 audits) is **G0: clarify porting rights with the Varylab/TU-Berlin authors**.

user2595 added 3 commits 2026-05-31 08:21:44 +00:00

docs(reviewer): add external audits — test/error-handling, API/perf, CGAL readiness 7902ae8e2c

Three complementary, self-contained audit documents (each actionable by a
fresh session, with file:line, code snippets, fixes, acceptance criteria):

- test-coverage-error-handling-audit: coverage gaps + error-handling robustness;
  agreed gate 80% line / 70% branch / 90% function.
- api-performance-audit: API-naming consistency (A1–A5, decided) + Newton-solver
  performance (B1 block-FD, redundant gradient evals, factorization reuse).
- cgal-submission-readiness-audit: G0 porting-rights blocker (original is
  unlicensed Varylab/TU-Berlin code; this is a derivative work — clarify with
  authors before any license/release), G1 license, layout, concept, manual, tests.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

docs(reviewer): add 4 gap audits — numerical, input-validation, thread-safety, dependency/license bad3c4a9ab

Closes the dimensions the prior audits did not cover:

- numerical-stability: tolerance hierarchy (FD-step vs Newton tol), discontinuous
  clamps, cancellation in cotangent/area, magic constants.
- input-validation: malformed JSON/XML deserialization, NaN/Inf vertex coords on
  load, schema-drift handling.
- thread-safety: no mutable static state (good); undocumented same-mesh concurrency
  contract; Eigen threading.
- dependency-license: existing THIRD-PARTY-LICENSES matrix is sound but predicated
  on the MIT premise that G0 undermines; test meshes have no provenance/license.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

docs(reviewer): add math-derivation & citation audit

C++ Tests / test-fast (pull_request) Successful in 2m23s

Details

C++ Tests / quality-gates (pull_request) Has been skipped

Details

C++ Tests / test-cgal (pull_request) Has been skipped

Details

b213ad2265

Checks code/docs against the published mathematics (vs java-port-audit which
checks code vs Java):
- M1: Kolpakov-Mednykh volume formula used in code but missing from references.md
- M2: BPS circle-packing paper cited as '2010' in code vs '2015' in references.md
- M3: post-2023/preprint citations back unimplemented phases — re-verify + clarify
  scope before submission
- M4: no canonical citation-key convention
- M5: large derivations numerically validated but prose unreviewed — expert sign-off

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

user2595 merged commit e13e7ea8e7 into main

2026-05-31 08:21:55 +00:00

user2595 referenced this issue from a commit

2026-05-31 08:21:56 +00:00

Merge pull request 'docs(reviewer): add 7 external audit documents (test/error, API/perf, CGAL, numerical, input, thread-safety, dependency, math/citation)' (#35) from audits-2026-05-31 into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: conformallab/ConformalLabpp#35