github-labels.rst

The following labels are used to help categorize issues:

spec-omission

Things which have been implemented but not currently specified. These may range from entire API endpoints, to particular options or return parameters.

Issues with this label will have been implemented in Synapse. Normally there will be a design document in Google Docs or similar which describes the feature.

Examples:

• Spec PUT /directory/list
• Unspec'd server_name request param for /join/{roomIdOrAlias}

clarification

An area where the spec could do with being more explicit.

Examples:

• Spec the implicit limit on /syncs
• Clarify the meaning of the currently_active flags in presence events

spec-bug

Something which is in the spec, but is wrong.

Note: this is not for things that are badly designed or don't work well (for which see 'improvement' or 'feature') - it is for places where the spec doesn't match reality.

Examples:

• swagger is wrong for directory PUT
• receipts section still refers to initialSync

improvement

A suggestion for a relatively simple improvement to the protocol.

Examples:

• We need a 'remove 3PID' API so that users can remove mappings
• We should mandate that /publicRooms requires an access_token

feature

A suggestion for a significant extension to the matrix protocol which needs considerable consideration before implementation.

Examples:

• Peer-to-peer Matrix
• Specify a means for clients to "edit" previous messages

wart

A point where the protocol is inconsistent or inelegant, but which isn't really causing anybody any problems right now. Might be nice to consider fixing one day.

question

A thought or idea about the protocol which we aren't really sure whether to pursue or not.

Examples:

• Should we prepend anti-eval code to our json responses?