dwyl/learn-elixir

Extend README Documentation

Open

#21 创建于 2017年2月8日

在 GitHub 查看
 (5 评论) (2 反应) (0 负责人)Elixir (1,695 star) (113 fork)batch import
discussenhancementhelp wanted

描述

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

贡献者指南

技术栈
elixir
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic knowledge of Elixirunderstanding of functional programming
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
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.