1
Fork 0
mirror of https://github.com/Steffo99/twom.git synced 2024-11-21 23:54:26 +00:00
pm-2024-steffo-twom/CONTRIBUTING.md

20 lines
1.2 KiB
Markdown
Raw Normal View History

# Random information that may be useful to contributors
## Custom Matrix types
- `eu.steffo.meta.twom.party`: room type used to distinguish TwoM parties from regular rooms, which are hidden.
- `eu.steffo.meta.twom.rsvp`: state event type used for the user's response to a party invitation; uses the replying user's mxid as state key, and has an object with the following keys as payload:
- `eu.steffo.meta.twom.answer`: a string containing one of these values, indicating the user's presence at the party:
- `"SURE"`
- `"LATER"`
- `"MAYBE"`
- `"NOWAY"`
- `""`
- `eu.steffo.meta.twom.comment`: a string containing an user's freeform comment provided in addition to the answer.
## Known issues
- Avatar URLs are sometimes fetched before they're available on the homeserver, causing them not to be loaded correctly on party creation.
- Due to API limitations, the app does not check if the user has permissions to perform certain actions, such as changing the name of a party, and instead returns a `MatrixError` when the action is attempted.
- Due to Matrix protocol limitations, any user can change other users' party replies by sending custom state events, even though this app itself does not allow it.