papercups-io/papercups

Rename "shout" event to "message:created"

Open

Aperta il 16 ago 2020

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)Elixir (6032 star) (566 fork)batch import
good first issuetech debt

Descrizione

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)

Guida contributor

Tech stack
elixir
Dominio
backend
Tipo issue
refactor
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Elixir basicsPhoenix Channels
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75
Direzione di ricerca
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.