pr

star 3.6k

FlexPrice PR self-review checklist — security, layering, migrations, tests. Trigger: pr check, ship review, pre-PR.

flexprice By flexprice schedule Updated 5/21/2026

name: pr description: >- FlexPrice PR self-review checklist — security, layering, migrations, tests. Trigger: pr check, ship review, pre-PR.

pr — pre-merge checklist

Run mentally or out loud through this list; fix gaps before requesting review.

Scope & layering

  • Change lives in correct layer (handler vs service vs domain vs repo per docs/ARCHITECTURE.md).
  • No new hidden globals unless unavoidable and documented (HOTSPOTS.md patterns).
  • Tenant/environment scoping preserved for multi-tenant data paths.

Security & config

  • No secrets, tokens, or production URLs committed (.env, keys in tests).
  • Auth/RBAC-sensitive routes still behind correct middleware (internal/api/router.go patterns).

Data & migrations

  • Ent schema edits accompanied by make generate-ent and migration plan (make migrate-ent / make generate-migration per deployment).
  • ClickHouse changes have matching files under migrations/clickhouse/ when applicable.

API & clients

  • Swagger annotations updated for new/changed endpoints; run make swagger.
  • If public SDK contract changes: make sdk-all (or agreed subset) and api/custom merged.

Quality

  • gofmt, go vet on affected scope.
  • go test -race on touched packages or make test for broad changes.
  • Prefer table-driven tests for multiple cases (internal/service/*_test.go conventions).

Docs & graph

  • Structural change updates docs/REPO_MAP.md / DEPENDENCY_GRAPH.md / FLOWS/* when behavior or topology changes.
  • If Graphify is used: graphify update . at repo root (see repo-architecture-intelligence personal skill).

Tone for reviewers

Summarize intent, risk, and test evidence in the PR body (not “fixed stuff”).

Install via CLI
npx skills add https://github.com/flexprice/flexprice --skill pr
Repository Details
star Stars 3,574
call_split Forks 168
navigation Branch main
article Path SKILL.md
More from Creator