Como Contribuir
Instruções de como contribuir no projeto
Antes de fazer qualquer alteração no repositório:
- Crie uma issue e se responsabilize por essa alteração. Atente-se a política de branches e a política de commits.
Histórico de versões
| Data | Versão | Descrição | Autor |
|---|---|---|---|
| 13/02/2022 | 0.1 | Envio inicial | Mateus Franco |
| 15/02/2022 | 0.2 | Mudança nas estimativas | Guilherme Santos |
Criação de Issues
Ao criar issues atente-se as seguintes questões:
- Já existe issue referente ao assunto que você pretende abordar na sua? Se sim, trabalhe a partir da issue já criada
- Adicione um título que sintetize bem o problema abordado na issue
- Adicione uma descrição adequada, de modo que qualquer membro do repositório consiga compreender qual é o problema
- Adicione ao menos um Assignee
- Adicione as Labels adequadas
- Adicione a milestone referente a sprint em que o problema será trabalhado
- Adicione um Estimate segundo as definições descritas nesse documento
- Utilize o issue template no momento da criação
Definição de Estimate
Deve-se definir uma estimativa de dificuldade (pontuação) à issue em questão, levando em consideração os seguintes critérios:
| Pontuação | Critérios |
|---|---|
| 1 | Tarefa bem simples, é possível ser feita em até 1h |
| 2 | Tarefa simples que leva algumas horas |
| 3 | Tarefa que pode levar algumas horas e necessita de alguma pesquisa |
| 5 | Tarefa tabalhosa, precisa de pesquisa e deve levar o dia todo |
| 8 | Tarefa não tão simples, precisa de pesquisa e deve levar alguns dias |
| 13 | Tarefa complexa, pode durar a semana toda |
| 21 | Tarefa muito complexa, provavelmente levará mais que uma sprint, melhor rever e dividir em mais de uma issue |
A pontuação da issue deverá ser levada a votação utilizando a ferramenta de planning poker do zenhub.
- Para issues que envolvem apenas um time, todo o time deverá ser adicionado ao planning poker.
- Para issues que envolvam mais de um time, apenas os colaboradores deverão ser adicionados ao planning poker.
Criação de Pull Request
Pull request permite que você informe outras pessoas sobre as alterações que você enviou para uma branch em um repositório no GitHub. Depois que uma pull request é aberta, você pode discutir e revisar as possíveis alterações com os colaboradores e adicionar confirmações de acompanhamento antes que suas alterações sejam mescladas na branch base.
Ao fazer um pull request atente-se para:
- Linkar o PR a sua Issue correspondente
- Marcar um dos responsáveis para revisão
Autor: Mateus Franco