shifathosn
/
pdfcraft
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
pdfcraft/.github/pull_request_template.md

3.4 KiB
Raw Blame History

What this changes

How you verified it

  • cargo fmt --check
  • clippy with -D warnings on the crates I changed
  • tests pass on the crates I changed
  • cargo xtask layers and cargo xtask assets (if you touched crate boundaries or any asset)

Tests. New behaviour needs a test at the right scale — a property test, a unit test, a crate integration test or an end-to-end one. For a bug fix, please check that the test fails before your fix by reverting the fix and watching it go red. A test nobody has seen fail is not evidence that it pins anything.

Never-crash

Every PDF, script, MCP call, settings file and keystroke is untrusted input (AGENTS.md §4).

  • No new unwrap/expect/panic!/unreachable!/todo! outside tests, unless it is provably infallible with a comment saying why
  • No indexing or slicing with input-derived positions (get, and strings only at char boundaries); checked or saturating arithmetic; allocations sized by input are capped; recursion is bounded
  • No unsafe
  • Any crash this fixes has a small synthetic regression test

Provenance

This is the part that cannot be undone after a merge, and the part a new contributor is least likely to know about. Please read AGENTS.md §1 before adding any asset.

  • No asset from an Adobe product, and no Adobe icon recreated, traced or imitated
  • No font files committed here (they live in storytold/craft-fonts)
  • No GPL/AGPL code copied in — MuPDF, Ghostscript, Poppler, veraPDF and DSS may only be run as external oracle processes
  • Behaviour comes from the specification or black-box observation, not from reading another implementation's source
  • Every new asset has an ATTRIBUTION.toml entry and cargo xtask assets passes

Security

  • --root confinement still holds on every path, including ones reached by nested tool dispatch
  • MCP and the UI control channel stay opt-in, loopback-only and token-authenticated
  • No new outbound network access (that decision is the owner's)

Parity and reach

  • parity/acrobat-features.toml updated in this PR, with notes saying what is still missing — shipped means "exists and tested", not "as good as Acrobat"
  • Reachable headlessly through an automation tool where that applies (AGENTS.md §3), so agents can drive it and not just the UI
  • Docs updated if this changes a documented behaviour (docs/, crate README)

Anything a reviewer should look at first