turicas/covid19-br

Atualizar documento de metodologia

Open

#136 opened on May 11, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (537 stars) (129 forks)batch import
documentationhelp wanted

Description

O documento de metodologia está no Google Docs, e está desatualizado.

Brasil.IO - COVID19 - Metodologia de coleta dos dados

Ele é referenciado no CONTRIBUTING.md e no README.md

Na minha visão, ele está muito cheio de detalhes que não são mais usados desde que o novo sistema está em uso.

Sugestão

Remover tudo que estiver desatualizado, simplificar, e compilar tudo no CONTRIBUTING.md ou criar um METODOLOGIA.md no repositório.

Com isso, tiramos a dependência de um arquivo no Google Docs, e fica tudo no repositório git mesmo.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Portuguese
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review the Google Docs methodology document at the linked URL. Check CONTRIBUTING.md and README.md for current references. Create a new METODOLOGIA.md file in the repository, condensing and updating the content. Remove outdated information and ensure the document is self contained within the repo.