christopheradams/elixir_style_guide

Best practice: How and where to put protocols and their implementation?

Open

#84 opened on Apr 5, 2016

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Elixir (301 forks)batch import
discussionenhancementhelp wantedquestion

Repository metrics

Stars
 (4,429 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I think it would help to have a common place to put protocol definitions and also implementations. It would be in particular interesting if protocols are implemented for existing modules.

For discussion:

definition:

file: lib/protocols/incredible.ex

implementation for a new modules within the module.

implementation for an existing module (e.g. Integer) in:

file: lib/protocols/impl/integer.ex

or

file: lib/protocols/integer_impl.ex

?

Contributor guide

Research direction
Explore the current protocol organization in the Elixir standard library and community, then propose a consistent convention for file placement and naming.
Tech stack
elixir
Domain
backend
Issue type
Documentation
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.
1-3 hours
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
Elixir
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70