-
Notifications
You must be signed in to change notification settings - Fork 160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc/design: clarify the life-cycle of a design doc and update existing accordingly #4634
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 12 of 13 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @jiceatscion)
doc/dev/contribute.rst
line 205 at r2 (raw file):
Once the implementation is deemed complete, the design document's status is changed to **Complete**, it is linked to the corresponding section of the index, and the
Suggestion:
Completed
doc/dev/design/index.rst
line 35 at r2 (raw file):
During implementation the design may also become suspended (**Postponed**) or abandonned (**Rejected** or **Outdated**).
Suggestion:
abandoned
The capitalization of the status in
could also be updated for consistency. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 11 of 13 files reviewed, 3 unresolved discussions (waiting on @jiceatscion)
doc/dev/contribute.rst
line 141 at r2 (raw file):
Typical examples for substantial change proposals include: * Adding, changing, or removing compontents or functionality
Suggestion:
components
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Reviewable status: 11 of 13 files reviewed, 3 unresolved discussions (waiting on @FR4NK-W)
doc/dev/contribute.rst
line 141 at r2 (raw file):
Typical examples for substantial change proposals include: * Adding, changing, or removing compontents or functionality
Done.
doc/dev/contribute.rst
line 205 at r2 (raw file):
Once the implementation is deemed complete, the design document's status is changed to **Complete**, it is linked to the corresponding section of the index, and the
Done.
doc/dev/design/index.rst
line 35 at r2 (raw file):
During implementation the design may also become suspended (**Postponed**) or abandonned (**Rejected** or **Outdated**).
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 7 of 7 files at r4, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @jiceatscion)
Fixes #4633