Annotate messages with descriptions of what they're used for
Open
Nobody has claimed this yet.
documentation
hold
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Description
Things like:
- response: Does this message send some kind of response.
- direct: Is this message sent to the user directly?
- channels: Which channels, if any, will this message be sent through?
- side_effects: Other messages (listed here) may be sent as a side-effect of this message. (For instance, the message to update the agenda sends the response "updated" but has the side-effect that the updated agenda item is pushed through the meeting channel)
- Validate the message references through testing, so we know that each referenced message actually exist. (And that responses are outgoing messages for instance)
- Option to cause exceptions if a message is sent in a way that's not declared.
- Create a browsable API(?) :)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the message definitions and the tests that reference them. Review how responses, direct messages, channels, and side effects are currently represented. Done would require an agreed annotation design, validation of referenced messages, enforcement behavior, and a decision on whether a browsable API is included.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100