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 (113 forks)batch import
discussenhancementhelp wanted

Métriques du dépôt

Stars
 (1 695 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Direction de recherche
Lisez le README.md actuel pour comprendre sa structure et son contenu. Pour chaque sujet non coché (Orienté Objet vs Fonctionnel, Modules Natifs, Pattern Matching, Elixir > Erlang > BEAM, Listes de Mots clés, Structures), recherchez et rédigez une documentation claire et concise avec des exemples. Référencez les sections existantes et maintenez la cohérence.
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitElixir
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85