Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 2.86 KB

Como contribuir

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 branchs e a política de commits.

Histórico de versões

Data Versão Descrição Autor
30/08/2021 0.1 Envio inicial Matheus Sousa
20/09/2021 0.2 Mudança na orientação para criação de Issues Matheus Sousa
20/09/2021 0.3 Revisão do documento e definição de estimate Thais Rebouças
20/09/2021 0.4 Pequena correção no histórico de versões Matheus Sousa

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

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 não tão simples, precisa de pesquisa e deve levar alguns dias
8 Tarefa complexa, pode durar a semana toda
13 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.

image

  • 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

Ao fazer um pull request atente-se para:

  • Linkar o PR a sua Issue correspondente
  • Marcar um dos responsáveis para revisão

Autor: Matheus Sousa e Thais Rebouças