- Propósito
- Documentação
- Membros do Time
- Pré-requisitos
- Instalação
- Definições, Acrônimos e Abreviações
- Ambientes
- Nossos Padrões de Código
- Execução de Testes
- Método de Versionamento
- Contribuições ao Repositório
- Critérios de Aceitação de Contribuições
<Descrição do propósito do sistema>
<Links para documentação técnica do sistema>
Bernadette Loscio Helton Santos Lairson Alencar Wilker Santos
<Ferramentas necessárias para se trabalhar no projeto>
| Tipo / Função | Ferramenta | Versão |
|---|---|---|
| Análise estática de código-fonte | Sonarqube | 5.6.6 |
| Biblioteca de build | ? | ? |
| Gerenciamento do controle de versões | GitLab | 9.5.1 |
| Framework de persistência | Hibernate | ? |
| Gerenciador de dependências | ? | ? |
| IDE | Eclipse | ? |
| Integração contínua | Jenkins | 2.72 |
| Kit de desenvolvimento | Java | ? |
| Servidor de aplicação | ? | ? |
| Sistema operacional | ? | ? |
<Hosts e seus respectivos endereços, em cada um dos ambientes (desenvolvimento, testes, homologação e produção)
<Se houver, descrição do padrão de codificação utilizado>
<Quais serão as abordagens para execução de testes>
<Formato da numeração de versão da ferramenta)
- Atualizar o código local.
[usuario@localhost siga]$ git remote update -p[usuario@localhost siga]$ git pull- Criar nova branch referente a um chamado.
[usuario@localhost siga]$ git checkout -b <branch> origin/master
**Ex.: git checkout -b ENH#0001 origin/master**Padrão: **[TIPO]#[NumeroIssue]**
Ex.: BUG#3
**Tipos disponíveis**:
###### BUG - Bug (Correção de bugs)
###### DOC - Documentation (Somente documentação é alterada)
###### ENH - Enhancement (Melhoria. Alteração envolve refactoring ou alteração que não está relacionada a um bug no sistema)
###### FEA - Feature (nova função ou novo requisito)
###### HOT - Hotfix (chamados imediatos)
###### QUA - Quality (Alterações realizadas em arquivos de configuração ou outro tipo de arquivo que somente a equipe de configuração possa alterar)
-
Criar merge request para a master do projeto.
Padrão:
Título: deve referenciar a mudança a ser realizada no código.
Descrição: deve detalhar as mudanças.
ATENÇÃO: O merge request deve possuir o identificador [WIP] no título do merge request.
-
Codificar.
-
Adicionar arquivos modificados.
[usuario@localhost IAGO]$ **git add arquivo**
**Ex.: git add CONTRIBUTING.md**- Commitar arquivos e escrever mensagem significativa.
[usuario@localhost IAGO]$ **git commit**
**Ex.: git commit**- Enviar branch para repositório remoto.
[usuario@localhost siga]$ **git push origin branch**)
**Ex.: git push origin DOC#3**-
Testar.
-
Retirar o prefixo [WIP] do merge request.
-
Arquivos do tipo:
.classpath
.project
-
Branch deve possuir o padrão estabelecido no item 2 da seção Contribuições ao Repositório.