Processo de Desenvolvimento
Descrição
Esta seção é dedicada a apresentar o processo de desenvolvimento do time, junto dela serão apresentados documentos referentes a maneira que o time se organizou e trabalha.
Sumário
Git Workflow
Branches
Nomes
Como padrão para nomes de branches, foi decidido o seguinte:
<numeroDaUS>/<nomeDoItem>-<detalheDoItem> (Caso seja uma User Story)
<tipoDeItem>-<nomeDoItem> (Caso seja um componente)
Exemplo de Componentes:
US01/TelaDeLogin-esqueciMinhaSenha
component-navBar
component-slider
Exemplo de Páginas:
page-recipes
page-creations
Criação
Para garantir que o processo de desenvolvimento esteja sempre atualizado, lembre-se de executar o seguinte comando na branch dev antes de criar uma branch nova:
git pull origin dev
Depois da execução desse comando é necessário oficialmente criar a Branch, para isso, execute o seguinte comando:
git checkout -b <nomeDaBranch>
Assim que criar a branch, é necessário fazer um push
para garantir que a mesma estará remota:
git push --set-upstream origin <nomeDaBranch>
Pronto! Agora você já pode começar a programar na sua Branch.
Commits
Para que o código desenvolvido seja salvo em sua branch de maneira remota, é necessário realizar os comandos de commit
e push
Salvando Localmente
Para garantir que apenas o código necessário para funcionamento da tarefa lembre-se de realizar o comando add
apenas nos arquivos essenciais para a tarefa:
git add <nomeDoArquivo>
Depois de adicionar todos os arquivos que deseja salvar, execute o commando de commit com uma mensagem curta que represente o que foi trabalhado nesses arquivos adicionados:
git commit -m 'descrição da tarefa em português'
Não hesite em realizar vários commits, assim podemos ter docuemntado e salvo vários estados do desenvolvimento
Salvando Remotamente
Depois de finalizar o desenvolvimento, envie todos os commits da sua máquina para o servidor remoto. Para isso depois de realizar as etapas de salvamento local, salve remotamente com o comando push
:
git push
Merge Requests
Depois de uma task ter sido desenvolvida e estiver pronta de acordo com os critérios de aceitação, é necessário que a mesma seja enviada para a branch de desenvolvimento. Para isso é necessário abrir um Merge Request pela platafora GitLab:
Criando o Merge Request
A criação pode ser realizada na seção Merge Requests do repositório em que a branch foi criada. Clicando no botão New Merge Request
siga os seguintes passos:
- Selecionar a branch de origem (sua branch de desenvolvimento);
- Selecionar a branch de destino (branch dev);
- Selecione
Compare branches and continue
- Em
Title
, escreva um título que descreva a funcionalidade adicionada ou bug corrigido; - Em
Description
, escreva uma descrição com uma breve justificativa nos arquivos que foram alterados; - Caso a tarefa seja visual (criação de componente/tela, correção de bug) adicione um gif exemplificando o uso (se considerar necessário);
- Na seção
Assignee
, selecioneAssign to me
para que fique registrado quem foi o responsável pelo desenvolvimento daquela tarefa (a pessoa selecionada será chamada caso o revisor tenha dúvidas sobre a tarefa); - Em
Milestone
selecione a Sprint em que a tarefa foi realizada; - Em
Labels
selecione qual é o tipo de tarefa que foi realizada; - Por último, revise se os arquivos que estão sendo enviados estão corretos e clique em
Submit Merge Request
.
Revisando o Merge Request
A revisão de merge request pode ser realizada por qualquer desenvolvedor, mas é preciso da aprovação de pelo menos um AGES III ou AGES IV para que a mesma seja incorporada na dev.
Na hora de revisar o Merge Request, entre na branch em sua máquina e teste a funcionalidade/bug/componente/tela de acordo com os critérios de aceitação apresentados no Airtable.
Caso haja pendências, relacionadas a documentação do código, padronização ou arquivos enviados, não exite em realizar um novo commit na branch com as mudanças necessárias antes de realizar a integração.
Matriz de Responsabilidade
Essa matriz foi desenvolvida para ajudar os membros do time a saberem seus papéis na dentro do processo de desenvolvimento.
Atividades | AGES I | AGES II | AGES III | AGES IV |
---|---|---|---|---|
Alimentar a wiki | R | R | R | R |
Definir squads | I | I | I | R |
Definir marcos da sprint | I | I | I | R |
Quebra de tasks | I/A | I/A | I/A | R |
Desenvolvimento | R | R | R | I |
Code review | R | R | R | I |
Executar testes funcionais | R | R | C | I |
Deploy da aplicação | I | I | R | I |
- I: Deve ser informado
- C: Deve ser consultado
- R: Responsável
- A: Aprova
Plano de Comunicação
Evento | Descrição | Responsável | Envolvidos | Frequência | Duração |
---|---|---|---|---|---|
Daily | Momento onde cada membro atualiza o time sobre o que fez, desde a última Daily, e o que fará a seguir. | AGES IV | AGES I, II, III e IV | Segundas e Quartas às 17:30 | 15 minutos |
Sprint Review | Apresentação das entregas realizadas e os possíveis débitos criados na Sprint. | AGES IV | AGES I, II, III, IV e Clientes | 1 vez no fim de cada Sprint | 30 minutos |
Sprint Retrospective | Momento dedicado à definir o que está funcionando para trabalhar e identificar problemas e melhoras a serem feitas. | AGES IV | AGES I, II, III e IV | 1 vez no fim de cada Sprint | 1 hora |
Sprint Planning | Reunião onde o time discute e define, a partir do Product Backlog e feedback atual do Cliente, o que será realizada na próxima Sprint. | AGES IV | AGES I, II, III e IV | 1 vez no começo de cada Sprint | 20 minutos |
Tasks Breakdown | O time realiza a quebra das tarefas a serem realizadas na próxima Sprint. Para isso, o time se divide nos grupos de Frontend e Backend. | AGES III e IV | AGES I, II, III e IV | 1 vez no começo de cada Sprint | 45 minutos |
Management Review | Encontro entre os AGES IV para revisão sobre como o projeto está progredindo e quais as próximas prioridades. | AGES IV | AGES IV | 1 vez por semana | Aproximadamente 30 minutos |
Apresentação do Cliente e da Ideia | Encontro onde o Cliente apresenta o projeto para o time. | Cliente | AGES I, II, III, IV e Cliente | 1 vez no início do projeto | 1 hora e 30 minutos |
Final Presentation | Apresentação final da AGES, na qual o time deve apresentar o projeto realizado para todos outros membros da AGES. | AGES IV | AGES I, II, III e IV | 1 vez no fim do projeto | 10 minutos |
Pre-Sprint review Meeting | Comunicação para revisão da apresentação que será realizada ao Cliente na Sprint Review. | AGES IV | AGES I, II, III e IV | 1 vez a cada Sprint | 30 minutos |
AGES Retrospective | Reunião com todos os alunos da AGES para que os organizadores da AGES recebam feedback e tenham melhor ciencia sobre o quão satisfeitos os alunos estão. | Staff da AGES | AGES I, II, III e IV | 2 vezes (05/05 e 28/06) | 1 hora e 30 minutos |
Plano de Riscos
Risco | Prevenção | Contingência | Estratégia |
---|---|---|---|
Atingir limite de uso gratuito da AWS (Exemplo) | Utilizar servidores apenas para validação, desligando-os quando não utilizados (Exemplo) | Alterar ambiente para outra conta de usuário (Exemplo) | Transferir (Exemplo) |
TBD... | TBD... | TBD... | TBD... |