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 (4,429 stars) (301 forks)batch import
discussionenhancementhelp wantedquestion

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

Tech stack
elixir
Domain
documentation
Issue type
documentation
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Elixir basicsProtocol concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Review the discussion comments for proposed conventions. Check existing lib/protocols directory and similar style guides. Propose a clear convention and submit a PR to add the section to the style guide's README or relevant file.
Best practice: How and where to put protocols and their implementation? · christopheradams/elixir_style_guide#84 | Good First Issue