nccgroup/sobelow

Installation docs incomplete

Open

#59 aberto em 20 de fev. de 2020

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Elixir (119 forks)batch import
backlogenhancementgood first issue

Métricas do repositório

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

Description

First, great project!

Some feedback though. It would ease the unnecessary learning curve for folks who come across this project and are like "what is phoenix? what is mix? how do I get this thing setup?", etc.

Adding some basics to the docs around how to actually use this thing on a computer, such apt-get install erlang elixir, mix local hex, .... would be very helpful to know ahead of time for initial setup.

Guia do colaborador

Direção de pesquisa
Adicione pré requisitos básicos de instalação, como instalar Erlang e Elixir, mix local hex, etc., ao README ou à documentação de instalação.
Pilha de tecnologia
elixir
Domain
security
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.
Menos de 1 hora
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90