zulip/zulip-terminal

Check formatting of markdown in notifications

Open

#1,174 opened on Mar 21, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (352 forks)github user discovery
area: notificationshelp wanted

Repository metrics

Stars
 (853 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Following #1173 it would be useful to look through other markdown in Zulip and see how it is output in notifications, and attempt to improve it if possible.

Possible issues:

  • realm emoji?
  • tables (also an issue in regular zulip notifications?)
  • rules (also in zulip?)
  • ...

Contributor guide

Research direction
Investigate how markdown is currently rendered in Zulip notifications, focusing on elements like realm emoji, tables, and rules. Identify inconsistencies and propose improvements.
Tech stack
python
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70