Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisão do readme.md #162

Open
11 of 13 tasks
silotto opened this issue Sep 14, 2022 · 0 comments
Open
11 of 13 tasks

Revisão do readme.md #162

silotto opened this issue Sep 14, 2022 · 0 comments

Comments

@silotto
Copy link

silotto commented Sep 14, 2022

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant