dwyl/learn-elixir

Extend README Documentation

Open

#21 aperta il 8 feb 2017

Vedi su GitHub
 (5 commenti) (2 reazioni) (0 assegnatari)Elixir (113 fork)batch import
discussenhancementhelp wanted

Metriche repository

Star
 (1695 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Inizia leggendo l'attuale README.md per comprenderne lo stile e il contenuto. Quindi, per ogni argomento non selezionato (ad esempio, Programmazione Orientata agli Oggetti vs Funzionale, Moduli Nativi, ecc.), ricerca e scrivi spiegazioni chiare adatte ai principianti. Inoltre, fai riferimento all'issue #57 per i contenuti sul pattern matching. Assicurati che tutte le nuove sezioni seguano la formattazione esistente.
Tech stack
elixir
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic knowledge of Elixirunderstanding of functional programming
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75