turicas/covid19-br

Atualizar documento de metodologia

Open

#136 opened on May 11, 2020

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

Repository metrics

Stars
 (537 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Create a new `METODOLOGIA.md` file in the repository with updated methodology content, removing outdated details. Then update `CONTRIBUTING.md` and `README.md` to link to this new file instead of the Google Doc.
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.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90