-
Notifications
You must be signed in to change notification settings - Fork 401
[WIP] MSC3868: Room Contribution #3868
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
Draft
jae1911
wants to merge
8
commits into
matrix-org:main
Choose a base branch
from
jae1911:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0d213af
Proposals: add room-contribution proposal
jae1911 22eab55
Proposal: rename and add MSC number
jae1911 aafc392
Proposals: wrap 120 chars
jae1911 eee445f
MSC3868: note publicity of room topic in alternatives
Mikaela 7d7e949
MSC3868: add unstable prefix
Mikaela f832ab1
MSC3868: remove hanging spaces
Mikaela 0bc970e
MSC3868: Clarify unawareness of issues, mention #3414 as a light depe…
Mikaela 2f516eb
MSC3868: add "badge_uri" parameter that links to a MXC URI
jae1911 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# MSC3868: Room Contribution | ||
|
||
Many projects and communities have a room on Matrix nowadays and many may wish to show their friends how to support | ||
them. | ||
The goal, would be to have something only visible to room & space members and to provide something easier to manage & | ||
display than putting links into the room topic or announcing them periodically. | ||
|
||
## Proposal | ||
|
||
This proposal implements a new `m.room.contribute` state event. This state event contains a "uri" parameter that may | ||
link to a git repo or any kind of URI and a "text" parameter that may contain the text of the button directing to the | ||
support link. There may be multiple "uri" and "text" parameters, each adding a different button containing a different | ||
link. Alternatively to the "uri" parameter, a "copy" one can be specified and will tell clients to copy the value in | ||
the clipboard. | ||
An example of this event would look like this: | ||
|
||
```json | ||
{ | ||
"links": [ | ||
{ | ||
"uri": "https://git.me/contribute", | ||
"text": "Contribute code!" | ||
}, | ||
{ | ||
"uri": "https://translate.me/contribute", | ||
"text": "Translate the project!" | ||
}, | ||
{ | ||
"uri": "mailto:team@verygoodproje.ct", | ||
"text": "Get in touch!" | ||
}, | ||
{ | ||
"text": "Donation IBAN", | ||
"copy": "CH5604835012345678009" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
## Potential issues | ||
|
||
// To be determined | ||
|
||
## Alternatives | ||
|
||
Historically, that sort of advertisement is either taken care of by adding the said URIs to the room topic or | ||
periodically sending an announcement in the channel. | ||
|
||
## Security considerations | ||
|
||
State events are currently not encrypted which could leak some data. | ||
|
||
## Dependencies | ||
|
||
None. |
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.
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.
Not actually relevant for this MSC (and imho not a blocker), but I want to have it noted at an area we can link to later:
This seems also a pretty good thing to have when we have profiles as rooms eventually :) Basically having "personal links" via this in a nice way.