dwyl/learn-elixir

Extend README Documentation

Open

#21 aberto em 8 de fev. de 2017

Ver no GitHub
 (5 comments) (2 reactions) (0 assignees)Elixir (113 forks)batch import
discussenhancementhelp wanted

Métricas do repositório

Stars
 (1.695 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Guia do colaborador

Direção de pesquisa
Leia o README.md atual para entender sua estrutura e conteúdo. Para cada tópico não marcado (Orientado a Objetos vs Funcional, Módulos Nativos, Pattern Matching, Elixir > Erlang > BEAM, Listas de Palavras chave, Structs), pesquise e escreva documentação clara e concisa com exemplos. Referencie seções existentes e mantenha a consistência.
Pilha de tecnologia
elixir
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitElixir
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85