Skip to content

docs: code knowledge for the v12 line (review lessons, checklist, project map) - #1637

Merged
HashEngineering merged 15 commits into
feat/kotlin-sdk-phase-1from
chore/code-knowledge
Oct 26, 2026
Merged

HashEngineering merged 15 commits into
feat/kotlin-sdk-phase-1from
chore/code-knowledge

Conversation

@abaranouski

@abaranouski abaranouski commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Issue being fixed or feature implemented

On v12 PRs, thepastaclaw and coderabbitai find the same few kinds of defect again and again:

  • an unreadable value is treated as zero or as "absent";
  • a fix opens the next interleaving;
  • the intent is written after the act it protects.

Each one gets rediscovered PR by PR, often over 20+ review rounds (#1570, #1576, #1616, #1621). This PR writes them
down once, together with a map of the v12 code, so that people and agents start from it.

Related PR's and Dependencies

What was done?

docs/code-knowledge/ is new and contains:

  • checklist.md: the questions the bots ask most often, one line each. Walk a diff through it before pushing.
  • 00-project-map.md: a map of the v12 code. It covers:
    • modules and flavors;
    • the three crypto stacks (dashj, the legacy Platform SDK, the Kotlin SDK);
    • who owns L1 after the cutover;
    • send routing and SdkWriteResult;
    • identities and DashPay, shielded;
    • persistence, tests and CI;
    • gotchas, and what to read before touching each area.
  • 01–09: rules by area. Each rule names the PRs it came from, so the reasoning can be checked:
    • fail-closed reads;
    • concurrency;
    • durability and recovery;
    • money, SDK and Platform;
    • Android lifecycle;
    • security and logging;
    • testing;
    • code style;
    • working with the review bots.

Sources.

Caveat. Some source PRs are still open (#1607, #1616, …). Names taken from them may not exist on the base yet; the
docs say so where it matters.

CLAUDE.md now links the folder. It also fixes three stale facts:

  • the UI uses ViewBinding, not Data Binding;
  • the build uses Gradle 8.13;
  • the Kotlin SDK owns L1 after the cutover.

.claude/skills/pre-review/ is out of scope here. It is a cherry-pick of #1634 (merged to master as cdaf542,
reviewed and approved there), included only because feat/kotlin-sdk-phase-1 does not have #1634 yet. It is byte
for byte identical to origin/master. Findings on it belong to a separate hardening PR into master. Some of them
were fixed and then reverted here, so that this PR does not fork the tool.

How Has This Been Tested?

Documentation only. I checked that the classes and functions the rules reference exist on the base with git grep;
the docs mark the ones from still-open PRs. /pre-review ran against feat/kotlin-sdk-phase-1, and its documentation findings are fixed. The tool's own test
suite passes (test_prereview.sh).

The project map also notes two possible issues. Both are inferred from the code and not verified:

  • the biometric-dismiss path in SecurityFunctions.authenticate may never resume;
  • FakeDashSpendService uses a testnet-only address on devnet.

They are left for separate follow-ups.

Checklist:

  • I have performed a self-review of my own code and added comments where necessary
  • I have added or updated relevant unit/integration/functional/e2e tests (documentation only)

🤖 Generated with Claude Code

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants