mirror of
https://github.com/storytold/pdfcraft.git
synced 2026-11-20 19:18:41 +00:00
Adopt the shared AGENTS.md (RFC-0072) (#7937)
* Adopt the shared AGENTS.md (RFC-0072) and test rules (RFC-0071) * Point removed AGENTS.md section references at the shared standards
This commit is contained in:
1 parent
20830d092c
commit
3f3b3e634a
47 files changed
+150
-324
No files matched your search
@@ -1,76 +0,0 @@
|
||||
<!--
|
||||
Thanks for contributing to PdfCraft.
|
||||
|
||||
Base this on `main` — it is the only integration branch. `main` moves fast (it took
|
||||
396 commits in the three days to 2026-10-12), so a PR that sits for a day usually needs
|
||||
a rebase. Rebasing the same day you are asked keeps the work from dying of conflicts.
|
||||
Delete any section below that does not apply.
|
||||
-->
|
||||
|
||||
## What this changes
|
||||
|
||||
<!-- What behaviour is different afterwards, and why it is worth doing. If it fixes an
|
||||
issue, say `Fixes #123`. -->
|
||||
|
||||
## How you verified it
|
||||
|
||||
<!-- The commands you ran and what they said. Per-crate is fine and preferred:
|
||||
`cargo test -p <crate>`. CI runs the full workspace on every PR, so you do not
|
||||
need to locally. -->
|
||||
|
||||
- [ ] `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](https://github.com/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
|
||||
|
||||
<!-- The judgement call you are least sure about, a deliberate restraint you want pinned,
|
||||
or a behaviour change existing users will notice. Say so here rather than leaving it
|
||||
to be found. -->
|
||||
Reference in new issue
Block a user