papercups-io/papercups

Rename "shout" event to "message:created"

Open

#156 geöffnet am 16. Aug. 2020

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Elixir (6.032 Stars) (566 Forks)batch import
good first issuetech debt

Beschreibung

This name is just the default event used when generating new channels in Phoenix, but let's make our event names a bit more descriptive... we already have conversation:created and conversation:updated events, so let's be consistent and add message:created in place of shout.

(Note: we'll probably need to keep "shout" around for backwards compatibility)

Contributor Guide

Tech Stack
elixir
Domain
backend
Issue Type
refactor
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Elixir basicsPhoenix Channels
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
Identify all references to the 'shout' event in the codebase, likely in channel files under lib/papercups web/channels/. Rename the event to 'message:created' and ensure backward compatibility by keeping 'shout' as an alias. Update any related tests and documentation. Check issue #156 comments for any additional details or discussions on the naming.