Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.73 KB

REVIEW.md

File metadata and controls

32 lines (24 loc) · 1.73 KB

Repository Code Review Checklist

Read REVIEW_COMMON.md (repo root) first - its contract binds this checklist. Architecture doc: CLAUDE.md.

Subfolders of this repository carry their own REVIEW.md checklists - a diff applies the REVIEW.md of every folder between this one and each file it changes.

A file also answers, by kind, to the checklists the folder walk finds starting from a second folder: a .h or .inc header under include/daScript/<dir>/ from src/<dir>/; a [test] file outside modules/, wherever the diff puts it, from tests/; a .cpp that includes doctest from tests-cpp/small/.

A diff that changes the by-kind routing rule above changes routed_paths in utils/internal/review-md/scan.das to match, in the same change.

A .das outside modules/ that requires modules from modules/<M>/, or a .cpp outside modules/ that includes a header from modules/<M>/, and from no other modules/ folder, answers to modules/<M>/REVIEW.md too, when that file exists - the reviewer applies this route, because the review walk does not.

Weakening REVIEW.das (beside this file) is a defect: dropping a check it runs, narrowing what a check walks, or rewording a finding so it no longer names what failed.

A diff that adds or changes a TOLERATED_SHARED_TWINS row names in its why the test compiling the files under its name together, or what keeps other processes from compiling two of them. Two files declaring one shared module name compiled together share the first's module.

A diff after which one process compiles two files that TOLERATED_SHARED_TWINS lists under one name, and no why among that name's rows names that process, is a defect - rename the module one of them declares.