mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-22 05:53:42 +01:00
Compare commits
5 commits
d20a46f864
...
1a3dc9fabd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1a3dc9fabd | ||
|
|
625ed5c599 | ||
|
|
53150b739b | ||
|
|
5e15bbdbdd | ||
|
|
d4e294ca28 |
|
|
@ -0,0 +1 @@
|
|||
Clarify that `format` is required if `formatted_body` is specified.
|
||||
1
changelogs/internal/newsfragments/2157.feature
Normal file
1
changelogs/internal/newsfragments/2157.feature
Normal file
|
|
@ -0,0 +1 @@
|
|||
Add "placeholder MSC" process definition.
|
||||
|
|
@ -497,6 +497,42 @@ In summary:
|
|||
a small table at the bottom mapping the various values from stable
|
||||
to unstable.
|
||||
|
||||
### Placeholder MSCs
|
||||
|
||||
Some proposals may contain security-sensitive or private context which can't be
|
||||
publicly disclosed until a later stage in the idea or solution process. Typically,
|
||||
the initial idea is validated using some amount of implementation or experimentation
|
||||
and may require an MSC number to make that implementation easier.
|
||||
|
||||
Placeholder MSCs are used to represent proposals in a state where implementation
|
||||
is ongoing, but the MSC details can't yet be disclosed. Authors which feel as
|
||||
though their MSC could be highly sensitive MUST get in contact with the Spec Core
|
||||
Team or [Security Team](https://matrix.org/security-disclosure-policy/) prior to
|
||||
opening their MSC. If either team determines that a placeholder MSC is required,
|
||||
it may be opened as such.
|
||||
|
||||
There are a few expectations attached to placeholder MSCs:
|
||||
|
||||
* They have a title which marks them WIP, and are in the "draft" state.
|
||||
* They have the following labels: `[proposal-placeholder, action-required, needs-implementation]`.
|
||||
* Notably, *not* `proposal`.
|
||||
* They are relatively short-lived (ideally less than 6-12 months in placeholder).
|
||||
* They propose solutions which are reasonably likely to be accepted. If a placeholder
|
||||
needs to be closed because the idea won't work, isn't needed, etc, then the MSC's
|
||||
content MUST be published ahead of that closure.
|
||||
* Note: the MSC's publication (and therefore closure) may be delayed until an
|
||||
appropriate point in the security disclosure cycle. For example, an alternative
|
||||
MSC being published, or a stream of work being completed.
|
||||
* When they are updated to receive real content, the following happens:
|
||||
1. The Spec Core Team or the author leaves a comment to cause a notification
|
||||
that the MSC has been replaced with real content.
|
||||
2. The `proposal` label (or its equivalent) is added to trigger chat notifications
|
||||
in the public Matrix rooms. The `proposal-placeholder` and `action-required`
|
||||
labels should be removed at this stage as well. Other labels are removed/applied
|
||||
per normal process.
|
||||
* The Spec Core Team is aware of the intended MSC's title and purpose. This is
|
||||
especially important if the Security Team approved the use of a placeholder MSC.
|
||||
|
||||
## Proposal Tracking
|
||||
|
||||
This is a living document generated from the list of proposals on the
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ properties:
|
|||
"1.10": This property can act as a caption for the audio.
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
x-addedInMatrixVersion: "1.10"
|
||||
formatted_body:
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ properties:
|
|||
type: string
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
formatted_body:
|
||||
description: |-
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ properties:
|
|||
"1.10": This property can act as a caption for the file.
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
x-addedInMatrixVersion: "1.10"
|
||||
formatted_body:
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ properties:
|
|||
"1.10": This property can act as a caption for the image.
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
x-addedInMatrixVersion: "1.10"
|
||||
formatted_body:
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ properties:
|
|||
verification.
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
formatted_body:
|
||||
description: |-
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ properties:
|
|||
type: string
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
formatted_body:
|
||||
description: |-
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ properties:
|
|||
type: string
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
formatted_body:
|
||||
description: |-
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ properties:
|
|||
"1.10": This property can act as a caption for the video.
|
||||
format:
|
||||
description: |-
|
||||
The format used in the `formatted_body`. Currently only
|
||||
`org.matrix.custom.html` is supported.
|
||||
The format used in the `formatted_body`. This is required if `formatted_body`
|
||||
is specified. Currently only `org.matrix.custom.html` is supported.
|
||||
type: string
|
||||
x-addedInMatrixVersion: "1.10"
|
||||
formatted_body:
|
||||
|
|
|
|||
Loading…
Reference in a new issue