dwyl/learn-elixir

Extend README Documentation

Open

#21 ouverte le 8 févr. 2017

Voir sur GitHub
 (5 commentaires) (2 réactions) (0 assignés)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

Guide contributeur

Stack technique
elixir
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic knowledge of Elixirunderstanding of functional programming
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75
Direction de recherche
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.