Políticas

1 - Introdução

Essa página tem como objetivo definir as políticas de branch, commits e pull requests a fim de padronizar e organizar o código do projeto no github. Abaixo será especificado o padrão para cada um desses itens.

2 - Políticas de Branch

As branchs devem ser sempre criadas a partir da "master" onde o código mais atual se encontra (Lembre-se de sempre dar um git pull para atualizar a branch master antes de criar outra). A criação da branch deve seguir o seguinte padrão:

git checkout -b "X-NomeDaBranch"

Onde "X" é o número da issue da Branch e o nome deve estar em PascalCase, ou seja, a primeira letra de cada palavra deve estar maiúscula¹. O nome deve estar em português.

3 - Políticas de Commits

Os commits devem seguir o seguinte padrão:

git commit -m "X - mensagem do commit"

Onde "X" é o número da issue e da branch e "mensagem do commit" é uma breve descrição do que foi feito no commit em português.

4 - Políticas de Pull Requests

Ao finalizar a issue, deve ser aberto no github um pull request da branch para a master. O padrão da Pull Request deve ser o seguinte:

Título do PR: "X - Nome da Issue"
Descrição: uma listagem do que foi feito na issue e no final deve ter "Closes #X". Onde "X" é o número da issue.

Um exemplo seria:

Título: 1 - Tema da Wiki e Políticas

Descrição:

- Mudança do nome do site para o app selecionado
- Adição da logo do app selecionado
- Modificação do tema de cores para a palete de cores do app selecionado
- Adição da página de políticas
Closes #1

5 - Referência Bibliográfica

https://celsokitamura.com.br

6 - Tabela de Versionamento

Data	Versão	Descrição	Autor	Revisor
10/04/2023	`0.1`	Criação da página de políticas	Natan Santana	Clara Ribeiro
15/04/2023	`0.2`	Adição da bibliografia	Natan Santana	Clara Ribeiro
18/04/2023	`0.3`	Adição da âncora para a referência bibliográfica	Natan Santana	Clara Ribeiro