Revisão do readme.md
silotto opened this issue · 1 comments
silotto commented
Esta edição faz parte do processo de revisão da Laboratoria Code Squads novembro 2020 da iniciativa Code for Development de @EL-BID
Problema de revisão de documentação - readme.md:
Tendo contrastado as informações apresentadas no repositório oficial com os campos solicitados no modelo de readme.md encontraram os seguintes pontos para melhorar:
- Adicione o logotipo para identificar o projeto.
- Adicione uma imagem ou gif do projeto para identificar sua principal funcionalidade.
- Incluir badges com o estado de desenvolvimento, licença, versão, cobertura, social ou outros. Esta ferramenta pode ser útil: https://shields.io/ (tutorial recomendado: https://www.youtube.com/watch?v=SIh5MQoQLPs)
- Forneça uma tabela com links para cada seção para funcionar como um índice.
- Especifique os pré-requisitos necessários para executar o projeto (ambiente, bibliotecas, dependências, entre outros), e forneça comandos de instalação para eles.
- Especifique se as variáveis de ambiente são necessárias e em qual parte da arquitetura elas são colocadas.
- Adicione uma lista de etapas que permitam a instalação e utilização do projeto localmente.
- Adicione o comando de execução para testes de unidade.
- Mencione as tecnologias utilizadas e adicione links referentes à documentação de cada uma.
- Se necessário, adicione trechos de código com exemplos de uso.
- Adicionar seção de autores.
- Adicione uma seção com o processo detalhado para contribuir com o projeto.
- Adicione uma seção especificando a licença de código aberto que está sendo usada redirecionando para o arquivo LICENSE.md.
Tiagoperes commented
This won't be fixed for now.