docs(runbooks): development, release, CI-triage and upstream-sync runbooks (2/5) - #16
Open
sqr00t wants to merge 1 commit into
Open
docs(runbooks): development, release, CI-triage and upstream-sync runbooks (2/5)#16sqr00t wants to merge 1 commit into
sqr00t wants to merge 1 commit into
Conversation
This was referenced Aug 18, 2026
sqr00t
marked this pull request as ready for review
August 18, 2026 18:12
This was referenced Aug 19, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #12.
Adds four operational runbooks under
docs/runbooks/, plus an index. No code changes —documentation only. Five files, 846 added lines, nothing deleted.
What is here
README.mdlocal-development.mdrelease-and-publish.mdci-triage.mdupstream-sync.mdbw, what may diverge, re-verifying goldensWhat to check when reviewing
Follow one, do not read it. These are procedures, and the only real test is whether they work
when executed cold.
local-development.mdon a machine without the toolchain already installed isthe highest-value check.
Two specific things worth a second opinion:
local-development.md(§5). Editing C++ and re-runningpytestwithout rebuilding silently tests the previously compiled
_core— the change appears to donothing. The runbook's stated fix should be the one you would actually use.
ci-triage.mdfor a failing regression test: is this a real modelchange or platform libm drift? That branch determines whether someone re-baselines a golden value
or hunts a bug, so getting it wrong is expensive in both directions.
ci-triage.md§2 also documents the Linux-versus-macOS divergence class (GCC/libstdc++ againstlibc++) that produced #7 and
bf87e07, because it reads as CI flakiness the first time you hit it.Stack
The stack is a single linear chain of six PRs; merge bottom-up. This PR is the fourth link in that
chain and the second of the five documentation PRs. It is based on
docs/adr-records(#15), not onmain, so review it after the PRs below it land or the diff will read wider than it is.