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

more tweaks

Browse source
This commit is contained in:
Matthew Hodgson 2018-05-14 22:13:28 +01:00
parent cb882ba12d
commit 93681458d6
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
specification/proposals_intro.rst
View file

@ -12,11 +12,11 @@ The process for submitting a Matrix Spec Change (MSC) Proposal is as follows:
- We also don't jump straight to PRing against the spec itself, as it's much faster to iterate on a proposal in freeform document form than in the terse and formal structure of the spec.
- In the proposal, please clearly state the problem being solved, and the possible solutions being proposed for solving it and their trade-offs.
- Proposal documents are intended to be as lightweight and flexible as the author desires; there is no formal template; the intention is to iterate as quickly as possible to get to a good design.
- make a new issue at https://github.com/matrix-org/matrix-doc/issues, whose description should list the metadata as per below.
- make a new issue at https://github.com/matrix-org/matrix-doc/issues (or modify an existing one), whose description should list the metadata as per below.
- Gather feedback as widely as possible from the community and core team on the proposal.
- The aim is to get maximum consensus on the trade-offs chosen to get an optimal solution.
- Iterating on the proposal and getting consensus can sometimes be time-consuming; an impartial 'shepherd' can be assigned to help guide the proposal through this process.
- Once the proposal has consensus and passed review, you **must** show an implementation to prove that it works well in practice, before before a spec PR will be accepted. Iterate on the proposal if needed.
- Iterating on the proposal and gathering consensus can sometimes be time-consuming; an impartial 'shepherd' can be assigned to help guide the proposal through this process.
- Once the proposal has sufficient consensus and passed review, you **must** show an implementation to prove that it works well in practice, before before a spec PR will be accepted. Iterate on the proposal if needed.
- Finally, please make a new spec PR which includes the proposed changes against https://github.com/matrix-org/matrix-doc/tree/master/specification. This will then be reviewed and hopefully merged!
The process for handling proposals is described in the following diagram. Note that the lifetime of a proposal is tracked through the corresponding labels for each stage in the `matrix-doc issue tracker <https://github.com/matrix-org/matrix-doc/issues>`_.