|
| 1 | +--- |
| 2 | +title: "review" |
| 3 | +output: |
| 4 | + rmarkdown::md_document: |
| 5 | + pandoc_args: [ |
| 6 | + "--wrap=none" |
| 7 | + ] |
| 8 | +--- |
| 9 | + |
| 10 | +## Revisão do pacote |
| 11 | + |
| 12 | +*Marque as caixas conforme aplicável e elabore nos comentários abaixo. Sua avaliação não se limita a estes tópicos, conforme descrito no guia do(a) revisor(a)* |
| 13 | + |
| 14 | +- **Descreva resumidamente qualquer relacionamento de trabalho que você tem (teve) com as pessoas autoras do pacote.** |
| 15 | +- [ ] Como revisor(a), confirmo que não há [conflitos de interesse](https://devguide.ropensci.org/policies.html#coi) para que eu revise este trabalho (se você não tiver certeza se está em conflito, fale com seu(sua) editor(a) _antes_ de iniciar sua revisão) |
| 16 | + |
| 17 | +#### Documentação |
| 18 | + |
| 19 | +O pacote inclui todas as seguintes formas de documentação: |
| 20 | + |
| 21 | +- [ ] **Uma declaração de necessidade:** declarando claramente os problemas que o software foi projetado para resolver além do seu público-alvo no README |
| 22 | +- [ ] **Instruções de instalação:** para a versão de desenvolvimento do pacote e quaisquer dependências que sejam fora do padrão no README |
| 23 | +- [ ] **Vignette(s):** demonstrando as principais funcionalidades com exemplos que são executados localmente com sucesso |
| 24 | +- [ ] **Documentação de funções:** para todas as funções exportadas |
| 25 | +- [ ] **Exemplos:** (que são executados localmente com sucesso) para todas as funções exportadas |
| 26 | +- [ ] **Diretrizes da comunidade:** incluindo diretrizes de contribuição no README ou CONTRIBUTING, e DESCRIPTION com `URL`, `BugReports` e `Maintainer` (o qual pode ser gerado automaticamente via `Authors@R`). |
| 27 | + |
| 28 | +#### Funcionalidade |
| 29 | + |
| 30 | +- [ ] **Instalação:** Processo de instalação documentado conclui com sucesso. |
| 31 | +- [ ] **Funcionalidade:** Qualquer funcionalidade que foi assumida pelo software foi confirmada. |
| 32 | +- [ ] **Desempenho:** Qualquer desempenho a mais que foi assumido pelo software foi confirmado. |
| 33 | +- [ ] **Testes automatizados:**Os testes unitários cobrem funções essenciais do pacote e uma gama razoável de *inputs* e condições. Todos os testes passam na máquina local. |
| 34 | +- [ ] **Diretrizes de empacotamento**: O pacote está em conformidade com as diretrizes de empacotamento da rOpenSci. |
| 35 | + |
| 36 | +Horas estimadas gastas na revisão: |
| 37 | + |
| 38 | +- [ ] Caso as pessoas autoras do pacote considerem apropriado, concordo em ser reconhecido(a) como revisor(a) do pacote (função "rev") no arquivo DESCRIPTION do pacote. |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +### Comentários da revisão |
0 commit comments