dwyl/learn-elixir

Extend README Documentation

Open

#21 opened on Feb 8, 2017

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Elixir (1,695 stars) (113 forks)batch import
discussenhancementhelp wanted

Description

Currently the README.md gives a good introduction by covering the basics. I feel as though this should be extended further to include more things integral to a functional programming language:

  • immutability
  • recursive functions
  • partial application
  • heads and tails

Does anyone have any thoughts on things to include?

Initial list of topics to add or extend within the documentation:

  • Generating an elixir project
  • Object Oriented vs Functional
  • Native Modules
  • Module Documentation
  • Testing
  • Pattern Matching - extend #57
  • Elixir -> Erlang -> BEAM
  • Pipe Operator
  • Maps
  • Keyword Lists
  • Structs

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.
1-2 days
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.
clear
Prerequisites
basic knowledge of Elixirunderstanding of functional programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Begin by reading the current README.md to understand the style and content. Then, for each unchecked topic (e.g., Object Oriented vs Functional, Native Modules, etc.), research and write clear explanations suitable for beginners. Also, refer to issue #57 for pattern matching content. Ensure all new sections follow the existing formatting.