Skip to content

PR Checklist

Jump to bottom
김성주 edited this page May 4, 2026 · 2 revisions

PR Checklist and Review Expectations

Use this checklist before opening or approving pull requests. Authoritative prose remains in AGENTS.md—when guidance diverges, AGENTS.md wins.

Pre-submit (author)

  1. Identify the owning crate for semantic changes (fission-pcode, fission-static, fission-automation, …)—fix bugs there, not only in CLI/Tauri printers.
  2. Run scoped validation:
    • cargo fmt --all
    • cargo clippy … -D warnings (respect workspace excludes documented for your area)
    • cargo test -p <impacted crates>
  3. If touching telemetry shared with automation, confirm consistency with NirBuildStats contracts (see AGENTS.md table).
  4. For user-visible behavior, cross-check docs/CLI.md and capture notes in the PR / forthcoming version-scoped release notes (GitHub Release); archived dated logs are under docs/changelog/Legacy/.
  5. Prefer deterministic behavior for code paths feeding snapshots or automation.

Reviewer focus

  1. Ownership: Reject “UI-only fixes” that paper over structuring or IR defects.
  2. Heuristics: One-off binary-specific shortcuts need invariant-based justification (per AGENTS.md anti-patterns).
  3. Tests: Targeted crate tests beat a single golden test when they lock invariants.

Merge hygiene

  1. Keep PRs logically scoped—large refactors are fine when they reduce coupling, but unrelated churn belongs elsewhere.
  2. Ensure CI signals align with risk (ci.yml fast gate vs post-merge heavy validation)—see CI/CD overview.

Related wiki pages

Related repository docs

  • AGENTS.md
  • Crate-local AGENTS.md files under crates/ (read the nearest child file before editing specialized areas)

Clone this wiki locally