matrix-org / matrix-org/mjolnir
The help text on `shutdown` should say that it creates a 'Content Violation Notice' room rather than just shutting down the room
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 445
- Forks
- 75
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 3
Description
Not thinking anything of it, I told someone that using the shutdown function of Mjolnir would be fine to 'close' a room, thinking it would just use the Synapse API.
The help text didn't mention this, but it created a new room called 'Content Violation Notice' and invited most of the users there and then told them off. That was not quite what we intended (related: #333).
This is a bit misleading from the command name, but worse is that I did actually read the help text and this wasn't mentioned at all. Ideally this would be mentioned in the help text :-)
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
Locate the help text for Mjolnir's shutdown command and read it alongside the command behavior described in the issue. Update the help text to state that shutdown creates a “Content Violation Notice” room and invites users, then verify that the command help accurately explains this behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100