wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Make the proposal labels match what happens in practice

Browse source
This commit is contained in:
Richard van der Hoff 2018-12-13 11:14:21 +00:00
parent 0f7e285f15
commit fa0b4f9e13
2 changed files with 33 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

3
scripts/proposals.py
View file

@ -9,8 +9,9 @@ from datetime import datetime
# a list of the labels we care about # a list of the labels we care about
LABELS_LIST=[ LABELS_LIST=[
'proposal-in-review', 'proposal-in-review',
'proposed-final-comment-period',
'proposal-final-comment-period', 'proposal-final-comment-period',
'proposal-merged', 'finished-final-comment-period',
'spec-pr-missing', 'spec-pr-missing',
'spec-pr-in-review', 'spec-pr-in-review',
'merged', 'merged',

53
specification/proposals_intro.rst
View file

@ -77,7 +77,7 @@ follows:
- In the document, clearly state the problem being solved, and the possible - In the document, clearly state the problem being solved, and the possible
solutions being proposed for solving it and their respective trade-offs. solutions being proposed for solving it and their respective trade-offs.
- Proposal documents are intended to be as lightweight and flexible as the - Proposal documents are intended to be as lightweight and flexible as the
author desires; there is no formal template; the intention is to iterate author desires; there is no formal template; the intention is to iterate
as quickly as possible to get to a good design. as quickly as possible to get to a good design.
- However, a `template with suggested headers - However, a `template with suggested headers
@ -95,7 +95,7 @@ follows:
follows the format ``1234-my-new-proposal.md`` where ``1234`` is the MSC follows the format ``1234-my-new-proposal.md`` where ``1234`` is the MSC
ID. ID.
- Your PR description must include a link to the rendered markdown document - Your PR description must include a link to the rendered markdown document
and a summary of the proposal. and a summary of the proposal.
- It is often very helpful to link any related MSCs or `matrix-doc issues - It is often very helpful to link any related MSCs or `matrix-doc issues
<https://github.com/matrix-org/matrix-doc/issues>`_ to give context <https://github.com/matrix-org/matrix-doc/issues>`_ to give context
for the proposal. for the proposal.
@ -185,32 +185,39 @@ labels for each stage on the `matrix-doc
| Proposal | | +------= Spec PR | | | Postponed | | Proposal | | +------= Spec PR | | | Postponed |
| Drafting and Initial | | | | Missing | | | | | Drafting and Initial | | | | Missing | | | |
| Feedback Gathering | | | | | | +-----------+ | Feedback Gathering | | | | | | +-----------+
| | | | +----+----+ | | | | | +----+----+ |
+----------+-----------+ | | | | +----------+ +----------+-----------+ | | | | +----------+
| | | v | | | | | | v | | |
v | | +-----------------+ | | Closed | v | | +-----------------+ | | Closed |
+-------------------+ | | | | | | | +-------------------+ | | | | | | |
| | | | | Spec PR Created | | +----------+ | | | | | Spec PR Created | | +----------+
| Proposal PR | | | | and In Review | | | Proposal PR | | | | and In Review | |
| Created and | | | | | | | In Review | | | | | |
| In Review | | | +--------+--------+ | | | | | +--------+--------+ |
| | | | | | +---------+---------+ | | | |
+---------+---------+ | | v | | | | v |
| | | +-----------+ | v | | +-----------+ |
v | | | | | +----------------------+ | | | | |
+----------------------+ | | | Spec PR | | | | | | | Spec PR | |
| | | | | Merged! | | | Proposed Final | | | | Merged! | |
| Final Comment Period | | | | | | | Comment Period | | | | | |
| | | | +-----------+ | | | | | +-----------+ |
+----------+-----------+ | | | +----------+-----------+ | | |
| | | | | | | |
v | | | v | | |
+-------------+ | | | +----------------------+ | | |
| | | | | | | | | |
| Proposal PR | | | | | Final Comment Period | | | |
| Merged! | | | | | | | | |
| | | | | +----------+-----------+ | | |
+------|------+ | | | | | | |
v | | |
+----------------------+ | | |
| | | | |
| Final Comment Period | | | |
| Complete | | | |
| | | | |
+----------+-----------+ | | |
| | | | | | | |
+-----------------+ | +-----------------+ |
| | | |
@ -226,11 +233,13 @@ Name GitHub Label Description
=============================== ============================= ==================================== =============================== ============================= ====================================
Proposal Drafting and Feedback N/A A proposal document which is still work-in-progress but is being shared to incorporate feedback Proposal Drafting and Feedback N/A A proposal document which is still work-in-progress but is being shared to incorporate feedback
Proposal In Review proposal-in-review A proposal document which is now ready and waiting for review by the Core Team and community Proposal In Review proposal-in-review A proposal document which is now ready and waiting for review by the Core Team and community
Proposal Final Comment Period proposal-final-comment-period A proposal document which has reached final comment period either for merge, closure or postponement Proposed Final Comment Period proposed-final-comment-period Currently awaiting signoff of a majority of team members in order to enter the final comment period
Proposal Merged/Spec PR Missing spec-pr-missing A proposal document which has passed review. Waiting for a PR against the Spec Final Comment Period final-comment-period A proposal document which has reached final comment period either for merge, closure or postponement
Spec PR In Review spec-pr-in-review A proposal that has been PR'd against the spec and is currently under review Final Commment Period Complete finished-final-comment-period The final comment period has been completed. Waiting for a demonstration implementation
Spec PR Missing spec-pr-missing The proposal has been agreed, and proven with a demonstration implementation. Waiting for a PR against the Spec
Spec PR In Review spec-pr-in-review The spec PR has been written, and is currently under review
Spec PR Merged merged A proposal with a sufficient working implementation and whose Spec PR has been merged! Spec PR Merged merged A proposal with a sufficient working implementation and whose Spec PR has been merged!
Postponed proposal-postponed A proposal that is temporarily blocked or a feature that may not be useful currently but perhaps Postponed proposal-postponed A proposal that is temporarily blocked or a feature that may not be useful currently but perhaps
sometime in the future sometime in the future
Closed proposal-closed A proposal which has been reviewed and deemed unsuitable for acceptance Closed proposal-closed A proposal which has been reviewed and deemed unsuitable for acceptance
=============================== ============================= ==================================== =============================== ============================= ====================================