dwyl/learn-elixir

Extend README Documentation

Open

#21 geöffnet am 8. Feb. 2017

Auf GitHub ansehen
 (5 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Elixir (113 Forks)batch import
discussenhancementhelp wanted

Repository-Metriken

Stars
 (1.695 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Lesen Sie die aktuelle README.md, um deren Struktur und Inhalt zu verstehen. Für jedes nicht abgehakte Thema (Objektorientiert vs. Funktional, Native Module, Pattern Matching, Elixir > Erlang > BEAM, Schlüsselwortlisten, Structs) recherchieren Sie und schreiben Sie eine klare, prägnante Dokumentation mit Beispielen. Beziehen Sie sich auf bestehende Abschnitte und bewahren Sie Konsistenz.
Tech Stack
elixir
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitElixir
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85