Repository navigation
docs(contributing): document the maintenance workflow the automation runs (#2782) - #2783
Merged
Merged
Conversation
Owner
Author
|
NEEDS CHANGES at
|
…runs (#2782) Adds contributing/maintenance.rst: actors and roles, the decision-watch, sweep and checkpoint loops, the issue and review label state machines, the pull request lifecycle, the decision loop, the post-merge routine and main-CI watch, throttles, briefs, the helper scripts, a bootstrapping checklist and a failure-mode table, with mermaid flowchart, sequence and state diagrams; lists it after workflows.
JarryShaw
force-pushed
the
docs/2782-maintenance-workflow
branch
from
November 4, 2026 22:11
fa42839 to
5756788
Compare
Owner
Author
|
GOOD TO GO at
Two items were declined, and I checked both declines against the sources: the review-budget cutoff wording, and |
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.
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
This adds
docs/source/contributing/maintenance.rst(Maintenance Workflow) to the toctree next tocontributing/workflows. The page sets out the maintenance workflow the automation runs on this repository. It is written to be read by a person and handed to an agent as a brief.It contains seven mermaid diagrams covering:
review:label state machines;It also covers the throttles and guards, the brief template, what each helper script does, a bootstrapping checklist, and a table of failure modes with the guard for each. Label meanings link to
process.rstrather than being restated, and rulings are paraphrased.A PR rather than a direct push, because the page codifies process. It adds no docs warnings (95 on main, 95 here). The docs-reading project tests and project half 1 pass.
Closes #2782