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.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- cli, documentation
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.
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 :-)
- Dominant language
- TypeScript
- Stars
- 445
- Forks
- 75
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 3
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.
More from matrix-org/mjolnir
-
matrix-org/mjolnir#667 · 1 comment · 1 assignee ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
matrix-org/mjolnir#652 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
matrix-org/mjolnir#649 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
matrix-org/mjolnir#648 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
matrix-org/mjolnir#647 ·
All issues in matrix-org/mjolnir
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100