Horizontal-org / Horizontal-org/Tella-Android

Revisão do readme.md

Open
#162 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Kotlin
Stars
113
Forks
29
Avg merge
2d 1h
Merged PRs (30d)
9

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open README.md and review the two unchecked items: development or project-status badges and the command for running unit tests. Check the repository's existing build and test setup before updating the documentation, then verify that the badges render and the documented test command works.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.