papercups-io/papercups

Rename "shout" event to "message:created"

Open

#156 opened on Aug 16, 2020

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Elixir (6,032 stars) (566 forks)batch import
good first issuetech debt

Description

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
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Elixir basicsPhoenix Channels
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.