Contribuição

Introdução

Este documento tem como objetivo apresentar as diretrizes para contribuição no projeto.

Commit

Mensagem de Commit

Os commits devem seguir o padrão de mensagem definido a seguir:

<tipo>: <descrição>

Onde <tipo> é um dos seguintes:

new: novo documento
update: atualização de documento
fix: correção
delete: remoção

E <descrição> é um breve texto que deve começar com um verbo no presente do indicativo, descrevendo o que foi feito. Exemplo:

new: adiciona elicitacao de requisitos

Regra de Commit

É importante notar que não são permitidos commits diretos na branch main. Todos os commits devem ser feitos em uma branch de desenvolvimento e, em seguida, mesclados na main através de um pull request, conforme ilustrado na Figura 1. Isso ajuda a manter a integridade da main e permite que as alterações sejam revisadas antes de serem incorporadas ao projeto.

Figura 1: Fluxo de trabalho com branches de desenvolvimento.

    gitGraph:
        options
        {
            "nodeSpacing": 100,
            "nodeRadius": 10
        }
        end

        branch entrega2/elicitacao-entrevista
        checkout entrega2/elicitacao-entrevista
        commit
        checkout main
        branch entrega2/priorizacao-moscow
        checkout entrega2/priorizacao-moscow
        commit
        checkout main
        branch entrega3/cenarios
        checkout entrega3/cenarios
        commit
        checkout main
        commit
        merge entrega2/elicitacao-entrevista
        merge entrega2/priorizacao-moscow
        merge entrega3/cenarios

Autor: Lucas Martins, 2024.

Branches

Branch Prinicpal

A branch principal do projeto é a main. Nela estão presentes os artefatos que estão finalizados e prontos para serem entregues.

Branches de Desenvolvimento

As branches de desenvolvimento devem seguir o padrão de nomenclatura definido a seguir:

<entregaX>/<artefato>

Onde <entregaX> é uma das entregas previstas no plano de ensino e <artefato> é o artefato que está sendo desenvolvido. Exemplo:

entrega2/priorizacao-moscow

Pull Request

Os Pull Requests (PRs) são a forma de submeter alterações para serem revisadas antes de serem incorporadas ao projeto. Eles devem seguir as seguintes regras:

O título do PR deve seguir o padrão de nomenclatura das branches de desenvolvimento.

O PR só pode ser mesclado após a aprovação de, no mínimo, um membro do time.

Páginas

As páginas do projeto devem seguir o padrão Exemplo.md.

Histórico de Versões

Versão	Data	Descrição	Autor	Revisor
1.0	30/04/2024	Criação do documento de contribuição	Lucas Martins	Kallyne Macedo