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 (566 forks)batch import
good first issuetech debt

Repository metrics

Stars
 (6,032 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Search the codebase for all occurrences of the 'shout' event and rename it to 'message:created', while keeping 'shout' as an alias for backward compatibility.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
ElixirPhoenix
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70