nccgroup/sobelow

Installation docs incomplete

Open

#59 ouverte le 20 févr. 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Elixir (119 forks)batch import
backlogenhancementgood first issue

Métriques du dépôt

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

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.

Guide contributeur

Direction de recherche
Ajoutez les prerequis d'installation de base tels que l'installation d'Erlang et Elixir, mix local hex, etc. dans le README ou la documentation d'installation.
Stack technique
elixir
Domaine
security
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.
Moins d'une heure
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90