matrix-org / matrix-org/mscbot-python

Users (who aren't whitelisted) who post top-level to an proposal should have their comment automatically moved to a PR review comment

Open
#30 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
7
Forks
2
PR merge metrics
No merged PRs in 30d

Description

The Spec Core Team often has the manual task of cleaning up comments that appear from contributors at the top-level of the MSC (a PR comment, rather than a PR review comment). Cleaning them up involves copying the contents of the comment, hiding it, then starting a new thread on the MSC (typically at line 1) and pasting the contents there as a quote. Along with some text to inform the user as to why it was necessary.

This is time-consuming manual work. And sometimes when we don't catch these comments quickly enough, other people will reply with another top-level comment, making the problem worse.

It would be nice if mscbot could take care of doing that automatically, along with a canned explanation. It should support a config option that excludes certain users (SCT, guardians, MSC author) who occasionally do need to post top-level from the correction.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is named in the issue. Start by locating the code that handles GitHub pull-request comments and configuration, then trace how top-level comments and user exclusions are represented. Done means eligible comments are moved into review threads with the canned explanation while excluded users are unaffected.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.