zulip/zulip-terminal

TRACKING: Migrate internal code to use Direct Message terminology

Open

#1,344 opened on Mar 21, 2023

View on GitHub
 (31 comments) (0 reactions) (0 assignees)Python (352 forks)github user discovery
TRACKINGapi migrationsarea: refactoringhelp wanted

Repository metrics

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

Description

This is a follow-up to the user-visible #1288, as fixed by #1322.

  • Rename/clarify internal variables; we could dedicate a specific task to this, but it may be more effective to migrate as-needed, where one part of the code is changed at a time, which relates to a particular other change underway
  • Update to follow API changes; these will likely not be rapid, and support the older API for some time in any case

Contributor guide

Research direction
Identify instances of old terminology (e.g., 'private message', 'PM') in the codebase and rename them to 'Direct Message' (DM) while updating related API calls and ensuring backward compatibility where needed.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50