Skip to content

verify-actual-behavior.md

Latest commit

 

History

History
24 lines (14 loc) · 1.24 KB

verify-actual-behavior.md

File metadata and controls

24 lines (14 loc) · 1.24 KB
Raw

Verify Actual Behavior

Trigger: Before asserting behavior of an external API, contract, library, or SDK that you have not opened in this session.

Rule

  • Read the source or run the thing before stating how it behaves.
  • If the source is not available, write a probe script and observe the response shape.
  • Cite by symbol in a code comment next to the call: // verified: <repo> <path/file.ext> <SymbolName>. Line numbers drift; symbol names are greppable.
  • Mark unverified claims with a // UNVERIFIED: ... comment in code and a _unverified_ note in PR descriptions. Do not paraphrase from recall.

Examples

Bad

"Curio's pdp.addStatus returns ok=true only when the AddPieces call fully succeeded."

Good

Read pdp/handlers.go:handleGetPieceAdditionStatus in filecoin-project/curio. Confirmed: txStatus='confirmed' only reports tx landing. addMessageOk and piecesAdded are separate booleans. Cite the file in the code comment that interprets the response.

Why

External APIs encode subtleties in field names that are not obvious from the name alone. The pdp.addStatus mistake (treating txStatus='confirmed' as success) silently corrupted migration state because the inner AddPieces call could fail while the tx landed.