Improve Readme.md file and provide more info
Aberta
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 11.8k
- Forks
- 7.9k
- Merge médio
- 1d 11h
- PRs com merge (30d)
- 11
Descrição
Please improve the readme file, the steps to run and install the repo locally are not clear.
I cannot get how do I install it on my system.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece lendo o README do repositório e verificando as instruções existentes de instalação e execução local. Atualize o README para que uma pessoa iniciante consiga seguir as etapas de configuração e entender como executar o repositório localmente; a issue não nomeia arquivos nem testes específicos.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100