cms-dev / cms-dev/cms

Matrix notifier for questions and announcements

Open
#1,350 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature_request
Dominant language
Python
Stars
1k
Forks
412
Avg merge
6d 10h
Merged PRs (30d)
3

Description

This is similar to the Telegram bot that was recently upstreamed. We use Matrix for our internal communications, so this basically has the same functionality but for Matrix. I think this is likely to be valuable to others, seeing as how Matrix has (at least at some point) been used for official IOI tasks.

Our implementation (https://github.com/e-i-o/cms/commit/32f90fce305e0d553e73f510716d92c3997f10f1) is like one of the old Telegram bot prototypes, in that it's write-only and lives directly in the CWS process. It would probably be possible to make it read-write, allowing to reply directly from matrix, but it would be a lot more effort and probably necessitate pulling in a matrix client SDK. It could also be moved to a separate Service while remaining write-only, which addresses some concerns I saw regarding the old telegram bot (means that CWS doesn't need to make web requests).

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

Start by comparing the existing Telegram bot with the linked implementation commit and inspect how the CWS process handles notifications. Decide whether the Matrix notifier should be write-only in CWS or a separate service, and clarify the expected question and announcement behavior before implementation. Done means the chosen Matrix integration works for those notifications.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.