Procedimentos para o uso de repositórios de arquivos

From COREPHP

A fim de reduzir problemas com o uso de repositórios de código, definimos um pequeno roteiro para que o código enviado ao repositório não sobrescreva código anterior com funcionalidade já implantada ou corrigida.

Este roteiro foi definido, porque muitas vezes um Desenvolvedor, acidentalmente ou não, não compara o código que criou com o código anterior. Embora as ferramentas como CVS e SVN dêem o aviso de que há conflitos, a resolução dos mesmos deve ser manual, pelo Desenvolvedor. O desenvolvimento de sistemas de forma colaborativa e com equipes disperças e de grande número, requerem maior cuidado, para evitar que códigos com problemas já resolvidos não reapareçam no deploy do sistema.

Regra de Ouro

O uso de repositórios deve ser realizado sempre para código 100% funcional.

   REPOSITÓRIO NÃO É BACKUP DE TRABALHO EM ANDAMENTO, MAS VERSIONAMENTO DE TRABALHO CONCLUÍDO.

Não use o repositório como seu backup pessoal. O código backapeado pode ser código não funcional, bloqueando o trabalho de seus colegas.

Checkout/Update

Realize o checkout/update constantemente, sempre antes de iniciar um novo trabalho, e antes da realização do commit. Se a [#Regra_de_Ouro Regra de Ouro] tiver sido seguida por todos, você não terá problemas com a versão obtida, pelo menos não terá problemas que impeçam o uso do sistema completamente.

Commit

O Commit de código deve ser realizado sempre que uma tarefa tiver sido concluída. Não espere concluir várias tarefas, lembre-se que outros podem estar aguardando uma correção que está com você para poder dar prosseguimento ao seu trabalho.

Para realização de um Commit, execute os seguintes passos:

0 - Realize o checkout/update do projeto. Sim, realize-o, assim você já terá, logo de cara, conflitos de versão, caso alguém tenha editado o mesmo arquivo que você.

1 - Faça um levantamento de todos os arquivos que foram alterados. Isso pode ser feito simulando-se o commit com a ferramenta utilizada para este fim, mas sem efetivamente submeter o código ao servidor.

2 - Com a listagem completa dos arquivos, vá, item por item, realizando Diffs (comparação de diferenças).

3 - Ao encontrar diferenças, aja da seguinte forma:

3.1 - Antes de mais nada, verifique se elas estão na área alterada por você. Se não, absorva-as à versão que você irá commitar.

3.2 - Verifique se é realmente o código anterior ou não. Pode ser que algum colega tenha já tenha corrigido o problema em questão, ou implementado a funcionalidade. Para esta verificação, será necessário fazer o diff da penúltima versão do arquivo, e não apenas da última.

4 - Documente seu comentário conforme as regras definidas em Padrões de comentários para repositórios de arquivos

Conclusão

1 - Não use o repositório como backup, faça commit apenas de código 100% funcional. 2 - Realize checkouts/updates permanentemente 3 - Vistorie as alterações antes de realizar o Commit