diff --git a/vignettes/guia-contrib.Rmd b/vignettes/guia-contrib.Rmd index 2461a3200360e6639703d2d8addfb0664c0596d8..c0b8d7ff758d3ed177df78850fa11dd7d4ff95d3 100644 --- a/vignettes/guia-contrib.Rmd +++ b/vignettes/guia-contrib.Rmd @@ -365,6 +365,54 @@ por causa do nome, segue breve explicação. próprios dados (11). Depois da documentação, um `NULL` deve estar presente (14). +## Fluxo de Trabalho + +O fluxograma abaixo resumo em linhas gerais o fluxo de trabalho do +*labestData*. O fluxo é composto de 3 partes: 1) a da esquerda resume +ações feitas no gitlab ou entre gitlab e repositório local; 2) a do meio +são ações usando o R com o pacote *devtools*; e 3) são as ações usando o +Git. + + + +A primeira coisa é ler o Guia de Contribuição, que é este documento. Em +seguida, catalogar toda a obra criando uma +[*milestone*](https://gitlab.c3sl.ufpr.br/pet-estatistica/labestData/milestones) +para ela. Dentro da *milestone* devem ser criados *issues*. Cada *issue* +deve ter o conteúdo para uma semana de desenvolvimento. + +O desenvolvimento começa com a criação de um ramo para inclusão das +contribuições. Cada *issue* no gitlab é numerado e para uma fácil +indentificação, o padrão é criar ramos autor numerados: `jhenifer33`, +`alessandra90`, `walmes160`. O ramo de desenvolvimento deve ser tirado +do ramo *baby*. Antes, no entanto, atualize o ramo *baby*. + +Com o Git no ramo de desenvolvimento, o trabalho de inclusão do conjunto +de dados começa com a criação do arquivo texto `txt` no diretório +`data-raw/`. O arquivo deve ser um TSV (*tab separeted values*) com +valores separados por tabulação e a primeira linha como cabeçalho. Você +tem a opção de fazer *commits* quando convier. Carregue os dados em uma +sessão R e gere o binário `rda` no diretório `data/`. Em seguida, +carrege o pacote e experimente os dados que acabou de incluir para +eliminar qualquer eventual erro. Escreva a documentação do conjunto de +dados no diretório `R/`. Use a função `roxy_data()` definida em +<https://gitlab.c3sl.ufpr.br/snippets/46>. Por fim, gere e verifique se +a transcrição para o formato `Rd` aconteceu sem erros. + +Agora que todos os arquivos foram criados (`txt`, `rda`, `R` e `Rd`), é +necessário fazer uma verificação completa no pacote. Se problemas +forem indentificados nessa fase, deve procurar fazer a correção antes de +subir. Se não houveram erros, então faça o empacotamento para gerar o +`tar.gz` do pacote. Por fim, suba para o repositório remoto no gitlab. + +Na interface do gitlab, faça um *merge request* (requisição de fusão) +para o *merger* designado à você. Se o MR for aceito, ponto positivo, +você pode fechar o *issue* pois o completou e remover o ramo que já não +é mais necessário. Caso contrário, providencie as correções indicadas +pelo *merger* e, quando prontas, notifique-o novamente no mesmo MR. + +O Projeto só termina quando todas as obras tiverem sido concluÃdas. + ## Referências Bibliográficas <!------------------------------------------- --> diff --git a/vignettes/img/crop-07.png b/vignettes/img/crop-07.png deleted file mode 100644 index d1be8868e60fcc30be2d34a3aa5581de00b3eda9..0000000000000000000000000000000000000000 Binary files a/vignettes/img/crop-07.png and /dev/null differ diff --git a/vignettes/img/workflow-labestData.png b/vignettes/img/workflow-labestData.png new file mode 100644 index 0000000000000000000000000000000000000000..dba0b59622c4408cbb05a3224ea3cdda42c90999 Binary files /dev/null and b/vignettes/img/workflow-labestData.png differ