Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
labestData
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Harbor Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
eys16
labestData
Commits
d4cd4517
Commit
d4cd4517
authored
8 years ago
by
Walmes Marques Zeviani
Browse files
Options
Downloads
Patches
Plain Diff
Adiciona seção com fluxograma do trabalho.
parent
8716c48f
No related branches found
No related tags found
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
vignettes/guia-contrib.Rmd
+48
-0
48 additions, 0 deletions
vignettes/guia-contrib.Rmd
vignettes/img/crop-07.png
+0
-0
0 additions, 0 deletions
vignettes/img/crop-07.png
vignettes/img/workflow-labestData.png
+0
-0
0 additions, 0 deletions
vignettes/img/workflow-labestData.png
with
48 additions
and
0 deletions
vignettes/guia-contrib.Rmd
+
48
−
0
View file @
d4cd4517
...
...
@@ -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
<!------------------------------------------- -->
...
...
This diff is collapsed.
Click to expand it.
vignettes/img/crop-07.png
deleted
100644 → 0
+
0
−
0
View file @
8716c48f
168 KiB
This diff is collapsed.
Click to expand it.
vignettes/img/workflow-labestData.png
0 → 100644
+
0
−
0
View file @
d4cd4517
142 KiB
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment