diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c7ccd74..a61797bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,26 @@ # Política de uso de repositório +### Política de Issues + +As issues devem possuir título, descrição, no mínimo um assinante responsável pela execução, labels indicando o grupo a quem se destina, a tarefa e milestone e estimated para as issues pontuadas e informar a sprint que ela deve ser concluída. + +As Labels usadas no projeto estão descritas no tópico [Labels](https://github.com/fga-gpp-mds/AGR-APP-react-native/labels) no Github. + +Para criação de issue o [template Issue](docs/ISSUE_TEMPLATE.md) deve ser seguido. + ### Política de Branches #### master
A branch master é a branch de produção, onde ficará a versão estável do projeto. Ela estará bloqueada para commits e para pushs. -Veja a política de merges no tópico merges para master.
+Veja a política de merges no tópico [Merges para master](CONTRIBUTING.md#merges-para-master). #### developmentA branch development é a branch de desenvolvimento, onde o trabalho das outras branchs será unificado e onde será criada uma versão estável para mesclar com a master. Assim como a master ela está bloqueada para commits e pushs. -Veja a política de merges no tópico merges para development .
+Veja a política de merges no tópico [Merges para development](CONTRIBUTING.md#merges-para-development) +merges para development . #### Nome das Branches @@ -36,21 +45,26 @@ git checkout -b X_nome_da_issue ### Política de Commits -Todos os commits devem ser feitos usando o comando `-s` para indicar sua assinatura no commit. +Todos os commits devem ser feitos usando o parâmetro `-s` para indicar sua assinatura no commit. ``` git commit -s ``` -A issue em questão deve ser citada no commit, para isso, basta adicionar `#`+numero_da_issue ao commit. +A issue em questão deve ser citada no commit, para isso, basta adicionar `#Para commits em dupla deve ser usado o comando `-s` igualmente, e deve ser adicionado a assinatura da sua dupla.
+Para commits em dupla deve ser usado o comando `-s` igualmente, e deve ser adicionado a assinatura da sua dupla.
``` git commit -s @@ -63,8 +77,14 @@ Signed-off-by: João Henrique EgewarthPara a equipe interna, os pull requests seram realizados em duas situações, para development e para master seguindo as regras e passos de merge para ambas branchs.
-Para ambos os casos deve ser seguido o [template Pull Request](https://github.com/fga-gpp-mds/AGR-APP-react-native/blob/2_template_issue_pull_request/docs/PULL_REQUEST_TEMPLATE.md). +Para ambos os casos deve ser seguido o [template Pull Request](docs/PULL_REQUEST_TEMPLATE.md). -##### Labels +##### Work in Progress -| Label name | Description -| --- | --- | -| `em-progresso` | Pull requests que ainda estão em andamento, mais modificações estão por vir. | -| `para-revisao` | Pull requests que precisam de revisão de código. | -| `em-revisao` | Pull requests em revisão de código. | -| `mudanca-requerida` | Pull requests que precisam de modificações e devem ser revisadas de novo. | -| `teste-requerido` | Pull requests que precisam ser testados. | +Caso haja a necessidade de atualizar a branch development antes de concluir a issue, o nome do pull request deve conter WIP: