Skip to content

docs: add HOW_TO_PR_UPSTREAM.md and a pr-upstream skill - #50

Merged
zackees merged 1 commit into
mainfrom
docs/how-to-pr-upstream
Oct 1, 2026
Merged

zackees merged 1 commit into
mainfrom
docs/how-to-pr-upstream

Conversation

@zackees

@zackees zackees commented Oct 1, 2026 •

Copy link
Copy Markdown
Owner

Makes the upstream PR process explicit and mandatory.

  • HOW_TO_PR_UPSTREAM.md is the full procedure behind the upstream debug-relocation PR's numbers: identical builds, captures, capture_ab.py settings (600 s / 300 s budgets, ABBA pairs, --no-fork, tmpfs output, discarding contaminated runs), correctness evidence (both build-id modes, forced fallback, cross-arch threshold test) and the fork CI A/B via a draft [bench] PR. It also covers verification (tests, clippy, nightly fmt, wasip1), the description format (italic AI-disclosure header, then Summary, Benchmarks, Design), the approval rule, review etiquette, and the lessons previously in AGENTS.md.
  • .claude/skills/pr-upstream/SKILL.md walks through the guide step by step and requires approval before anything is posted upstream.
  • AGENTS.md now makes reading the guide and using the skill mandatory before authoring an upstream PR. The long lessons section moved into the guide, so there's one source of truth.
  • benchmarks/performance_guard/make_small_captures.sh regenerates the tinyc (5,000 C files) and cxxdbg (1,500 C++ files) small-link captures. Verified locally: both capture, relink and run.
  • REUSE.toml covers the new files.

…r upstream PRs

HOW_TO_PR_UPSTREAM.md records the full procedure behind the numbers in wild-linker#2634:
how the binaries are built, the captures, capture_ab.py settings (budgets, ABBA pairs, tmpfs
output, discarding contaminated runs), correctness evidence and the fork CI A/B. It also
covers the verification steps, the PR description format (italic AI-disclosure header, then
Summary, Benchmarks, Design), the approval rule, and the lessons previously in AGENTS.md.

The pr-upstream repo skill walks through it, and AGENTS.md makes reading it mandatory before
authoring an upstream PR. make_small_captures.sh regenerates the tinyc and cxxdbg small-link
captures.
@zackees
zackees merged commit ad1e8ad into main Oct 1, 2026
28 checks passed
@zackees
zackees deleted the docs/how-to-pr-upstream branch October 1, 2026 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant