Skip to content

Documentação de desenvolvimento

Renata Brasil edited this page Sep 28, 2017 · 1 revision

Fluxo de trabalho

Vamos usar apenas uma branch por enquanto.

A forma de trabalho será através dos quatro passos abaixo.

1) git pull origin master

Sempre dar o pull antes de começar.

Comando:

$ git pull origin master

2) Sempre fazer a build local

Comando:

$ rake

Isso roda todos os testes. Só commitar depois de rodar todos os testes localmente e eles passarem.

3) git commit

Comandos:

Verificar arquivos novos ou modificados:

$ git status

Adicionando arquivos para a área de commit:

$ git add <arquivos>

ou

$ git add . (inclui todos os arquivos modificados ou novos)

Exemplo:

$ git add /spec/features/model/ (adicionou a pasta model para o "commit")

Comandos para o commit:

$ git commit Abre uma tela nova para que o título.

git commit -a -m "Título do commit" (um comando só para adicionar tudo que é novo ou modificado e o título do commit).

Resumindo:

Primeiro você adiciona os arquivos para a área de commit (staged area), depois usa o comando para o commit.

Regras a seguir:

a) Quando commitar

Commitar arquivos referentes ao mesmo propósito. Por exemplo, commitar os arquivos referentes à implementação da história. Se durante o desenvolvimento arquivos de configuração foram modificados ou inseridos, eles devem ser commitados em um commit específico diferente do commit da história.

Sempre que alguma ação for concluída na história, por exemplo, o cadastro da história CRUD cliente foi concluído, isso deve ser um commit.

Mas coisas pequenas também podem ser commitadas, desde que estejam agrupadas com o mesmo propósito.

b) Título do commit

Tem que descrever a contribuição. Por exemplo:

  • Adição da controller de Clientes
  • Adição da action destroy na controller de Clientes

c) Texto do commit

Descrição sobre o que foi mexido. Exemplo:

Título do commit: Adição da controller de Clientes Descrição:

Criação de ClientesController e das actions create, new, edit e update. Criação do arquivo create_clientes.feature (cucumber)

4) git push

Não deve demorar muito para dar o push. O sistema precisa estar atualizado. O push deve ser dado depois do passo 2 ter sido executado.