Coding Practices

Standardized coding patterns and conventions used across projects.

Documentation

Document Description
go Go project structure, patterns, and conventions
sveltekit SvelteKit patterns — shadcn UI, state vs stores, SSR
s3-image-uploads Server-side S3 image upload pattern for SvelteKit (Sharp + AWS SDK)
vcr-casette-testing Record/replay HTTP fixtures for deterministic network tests — and their supply-chain caveats
ui-theming System-mode auto-detect with an escape hatch, semantic tokens, and shippable coding-theme palettes
contributing-to-fast-moving-dependencies Making upstream behavior addressable: regression batteries and triage gates when contributing; pinned-image contract tests and a CI-proven compatibility matrix when consuming
swiftui SwiftUI mapped onto Svelte 5 — menu-bar apps, SwiftPM-only builds, a hand-rolled typed GraphQL client, two-signal transitions, the element-binding exclusivity trap
macos-development Keychain items, code signing as keychain access control, the untrusted-cert rebuild-prompt trap
macos-app-distribution Developer ID → hardened runtime → notarize → staple; SwiftPM-to-.app bundling, a zero-dependency icns pipeline, the tag-driven release pipeline, Sparkle auto-update, and a Homebrew tap
staged-batch-rewrites Bulk edits over a per-item API: stage → show blast radius → apply, converging on retry instead of transactions
swiftui-drag-drop-transferable In-app drag & drop with Codable Transferable payloads — multi-select drags, staging drops, mutable-row pitfalls
swift-tailwind-comparison SwiftUI styling for Tailwind hands — the utility-class dictionary, modifier order as box model, hover intent, withAnimation + transitions
local-first-sync Dirty-flag + identity-map + tombstone + checkpoint sync: LWW reconciliation and the delta-feed contract
sync-engine-testing Layered proof for sync engines: protocol-seam fakes, an env-gated live integration test, and naming the residue
deriving-from-gpl-code GPL core + AGPL additions via GPLv3 §13, with SPDX headers as the provenance boundary
git-subtree-vendoring Vendor a repo into a monorepo with pinned provenance and a merge path for upstream fixes
swiftpm-package-access-target-splitting Split an app target into shareable libraries with package access — tiered visibility, memberwise-init caps, the case-insensitive product collision
restricted-entitlements-outside-xcode Profiles grant, signatures claim: the entitlements Xcode injects silently, and how a scripted codesign pipeline must inject them itself
cloudkit-schema-deployment Never hand-type a promote-only schema: JIT-generate from the codec, promote, capture with cktool as a reviewed migration artifact
lockstep-artifact-versioning One product, many artifacts, one version: the tag as single source of truth, package-time stamping, unchanged components republish harmlessly
bundling-brand-fonts-swiftpm Ship a wordmark font in a SwiftPM app — license check, process-scoped registration, variable-font instance names, the resource-bundle copy trap
release-asset-capture-pipeline Reproducible product screenshots/recordings — shot-list manifest as contract, demo-mode data, frozen encode recipes, provenance-gated freshness advisory
frame-extracted-ui-verification Prove or disprove sub-second UI glitches: record the transition, dedupe to distinct frames, and treat the set as every state that rendered
animated-svg-system-diagrams Declarative node/edge SVG schematics with GSAP MotionPath pulses — paint order as the layout algorithm, theming via utility classes, reduced-motion skips GSAP entirely
k6 k6 as a synthetic data seeder, not just a load tester — speak the tracker protocol, shape distributions per report, backdate history

Topics to Document

  • Memory access semantics as a paradigms-level doc (Swift's law of exclusivity, Rust's borrow checker, Go's race detector as three answers to aliased mutation) — split out of swiftui's element-binding exclusivity section once a second, non-Swift encounter gives it independent provenance
  • Error handling patterns (cross-language)
  • Testing strategies
  • Code review checklists
  • Git workflow conventions