O objetivo deste repositório é gerenciar as pendências do projeto Pauliceia relacionadas aos demais repositórios. Através dele será possível acompanhar as issues (ou tarefas) relacionadas à evolução técnica e de gestão de processos e documentação da plataforma e do grupo de pesquisa. A seguir, uma breve explicação do funcionamento e da operação dessa estrutura de gestão do Github.
Este repositório issues possui duas outras seções importantes, entre as abas acima você poderá ver a aba Issues e a Projects. Será principalmente a partir destas duas abas que faremos o acompanhamento de forma transparente e eficiente do nosso trabalho.
Na aba Issues é possível criar tarefas e registrar o andamento delas. Para criar uma issue, basta entrar na aba de Issues e clicar no botão New issue, como na imagem abaixo:
Depois disso, você será direcionado à página de criação da issue, onde poderá inserir todas as informações necessárias para registrá-la no sistema. Nesta janela será possível escrever e pré-visualizar o texto antes de submeter a issue. O formato do texto pode parecer estranho para você à primeira vista, é que o Github usa um formato chamado de Markdown, que basicamente converte o texto que escrevemos aqui para HTML. Mas não se preocupe, não é nenhuma linguagem complicada de entender ou aprender!
O Github também facilita bastante fornecendo alguns botões para funções que já usamos em editores de texto comuns, como, por exemplo, adicionar negrito ao texto ou adicionar um link.
Você deverá escolher um título e uma descrição ou comentário para sua issue. No campo da descrição é possível inserir uma lista de tarefas, mencionar usuários que estão neste repositório, inserir imagens e links, etc.
Antes de submeter a sua issue você poderá pré-visualizar o texto e checar se está tudo ok, basta clicar no aba Preview:
Depois de escrever o texto da issue, o próximo passo é fazer algumas configurações extras importantes antes de finalmente submetê-la. Na lateral direita é possível ver algumas opções adicionais de configuração da sua issue.
O ideal é que toda issue seja atribuída (assigned) a alguém que ficará a cargo dela, podendo ser a própria pessoa que a criou e/ou outra(s) pessoa(s). O primeiro passo, portanto, é atribuí-la a você ou a outra(s) pessoa(s) na opção Assignees, clicando no ícone da engrenagem e procurando o nome de usuário da pessoa escolhida. Basta clicar no nome e pronto!
Se a seleção der certo será possível visualizar em seguida o nome da pessoa selecionada abaixo do título Assignees. Caso deseje adicionar outra(s) pessoa(s) ou mesmo excluir pessoa(s) adicionada(s) previamente, basta seguir o mesmo procedimento.
Para efeitos de indexação, é possível atribuir rótulos (labels) para uma issue. Isso é muito útil para classificar e separar as issues por tipo, mas também para facilitar na hora de acharmos uma issue na opção de busca. Esses Labels são editáveis, ou seja, podemos criar novos, excluir ou editar os já criados. O procedimento para definir um Label é o mesmo do Passo 1, basta clicar na engrenagem e escolher o Label.
Após selecionar o rótulo que deseja adicionar à issue ele aparecerá abaixo do título Labels:
Ao cliclar no botão Edit labels você será redirecionado para uma outra página onde será possível criar, editar e deletar labels, como é mostrado na imagem abaixo. É recomendável que você atribua um dos rótulos já existentes à issue que você está criando ou, na ausência de um adequado, crie um novo que traduza melhor o seu tipo de issue. Apenas tome cuidado para não exagerar na dose e acabar criando Labels extremamente específicos. A ideia dos Labels é funcionar como uma caixinha onde podemos procurar depois por todas as issues sobre documentação (documentation), por exemplo. Recomendamos que antes de editar ou deletar um label você consulte o grupo para que não corra o risco de editar ou deletar um rótulo importante.
Na aba Projects estão espaços diferentes destinados a registrar em formato mais amigável de mural as nossas atividades "a fazer" (coluna To do), "em progresso" (coluna In progress) e "feitas" (coluna Done). Ambas as abas, Issues e Projects podem ser conectadas de modo a facilitar o nosso processo de registro e documentação do projeto. Por exemplo, ao criar uma issue você poderá escolher ligá-la a um dos Projects. Fazendo isso, o Github automaticamente inclui a sua issue como tarefa dentro daquele Project escolhido. No exemplo abaixo você vê o procedimento de linkar a issue a um projeto, que é basicamente o mesmo das etapas anteriores: clica na engrenagem e escolhe um item da lista.
Após escolhido o projeto a ser linkado, ele aparecerá abaixo do título Projects:
Apenas depois que você submeter a issue, será possível alterar o status dela e assim alterá-lo também dentro do projeto correspondente. Veja na imagem abaixo como isso pode ser feito:
Sua issue linkada a um Project vira um card dentro das colunas do projeto e o status dele passa a ser alterado automaticamente à medida em que você altera a sua issue. Isso poupa tempo e torna o processo de documentação mais eficiente
Milestones (ou marcos temporais, como poderíamos traduzir livremente) servem para estabelecer prazos para realização de issues. Você pode atribuir um período para que determinadas issues sejam completadas. O procedimento é o mesmo das configurações anteriores:
Caso você precise criar um novo Milestone, você precisará ir para a aba Issues e em seguida clicar em Milestones. Após isso, você será redirecionado para outra página onde será possível visualizar e editar os Milestones já criado, assim como criar novos:
Os quatro passos acima são opcionais para a criação da issue, mas são importantes porque ajudam a registrar de forma transparente as atividades do projeto. Uma vez completados esses passos você pode finalmente submeter sua issue. Isso é feito clicando no botão Submit new issue. Depois de submetida, você será redirecionado para a página abaixo, onde verá todas as informações da issue recém-criada e poderá editá-la ou criar uma nova.
As issues são ótimos espaços para discutir com o grupo os pormenores do projeto. Você pode deixar comentários para usuários específicos fazendo observações sobre algum aspecto do projeto e da própria issue, ou se dirigir ao grupo como um todo. Uma vez completado o objetivo da issue ela deve ser fechada e após fechada fica arquivada como registro no repositório, onde constam as issues abertas e as fechadas.