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.