docs: add design proposal workflow - #70
Merged
Merged
Conversation
Signed-off-by: jiangxt2 <jiangxt2@vip.qq.com>
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.
Description
This PR establishes a repository-owned design proposal workflow for architectural changes that need review before implementation. It keeps proposal discussion separate from accepted ADRs, implemented architecture documentation, and support claims.
The change:
design-docs/README.mdto define document responsibilities, proposal entry criteria, Draft PR review, acceptance, rejection, supersession, and implementation follow-up;design-docs/template.mdwith motivation, goals, non-goals, current evidence, component ownership, public contracts, stability, failure and security semantics, compatibility, alternatives, acceptance criteria, open questions, decision outcome, and implementation tracking;CONTRIBUTING.mdand defines when a design proposal is required or unnecessary.An accepted proposal approves a design direction but does not claim that a feature is implemented or supported. Existing ADRs, architecture documents, the decision log, Issue and PR templates, runtime code, dependencies, and package versions are unchanged.
Related issues
None.
Additional information
uv run --locked --no-sync python scripts/pr-precheck.pypassed on the final three-file documentation change, including all static layers, changed-test planning, CI parity, and Docs CI parity.git diff --checkpassed.