Como Contribuir

Home > Como Contribuir

Informações sobre Contribuição com o REST DataWare - Manual de normas técnicas:

Toda alteração de código precisa ser enviada através de Pull Request(PR). Caso o PR contenha mais de um commit, cada commit deverá ter comentário explicando o que foi alterado. O PR final deverá conter somente um resumo das alterações
Todas as mensagens, units, métodos, funções, enumerados, classes e nomes, exceto comentários, devem ser padronizados obrigatoriamente em inglês.
As mensagens para o usuário final deverão ser em inglês e devidamente encapsuladas em constantes que ficarão na uRESTDWConsts
O código precisa ser em Object Pascal o mais simples possível que atenda tanto Delphis velhos como o 7 quanto Delphis mais novos e Lazarus
O código precisa ser testado em Delphi e Lazarus antes de enviar o PR com o ajuste.
Caso o PR corrija alguma tarefa (issue) basta informar no comentário do commit o número da issue com a palavra-chave Fixed, por exemplo: Fixed #1
Não existe PR para alterações na Wiki, os PRs são apenas para alterações no código-fonte da suíte de componentes.
O PR só pode ser feito com a última versão dos fontes, se for feito baseado em versão antiga será desconsiderado.
Precisa se atentar à versão que o PR está atendendo, todo PR deverá ser feito no branch dev.
Atente-se para a identação do código: procure manter o padrão atual de identação do código sempre.
Qualquer nova unit precisa seguir o padrão uRESTDW + nome da unit, por exemplo, a unit teste ficaria uRESTDWTest, seguindo o padrão do item 2

O versionamento da suíte de componentes segue o versionamento semântico Major.Minor.Release-Commit com as seguintes regras:

A versão do trunk master sempre será 1 valor release acima do último lançamento de versão.
Ajustes no código que podem ser atualizados sem precisar mudar nenhum sistema já existente, só alteram valor do Commit.
Ajustes no código que precisam mudar algo no código de sistemas já existentes, sem precisar grandes mudanças, devem incrementar o valor da versão Minorem 1 e não podem ser diretamente inclusos no trunk master, precisam ser inclusos no branch dev.
Ajustes no código que mudam completamente a estrutura do componente ou que fazem mudanças drásticas de código, precisam ser inclusos em um branch novo com versão Major incrementada em 1.
O valor do Commit sempre reseta a cada lançamento de versão, por exemplo: versão 2.1.0-150 foi lançada => nova versão 2.1.1-1.
O valor do Commit representa o total de commits feitos no código em relação à versão lançada anteriormente, essa informação é facilmente vista na página da última versão lançada.

Clique no botão "Fork" acima para criar uma cópia do repositório na sua conta:
Na próxima página, desmarque a caixa que limita a cópia somente do master pra conseguir copiar o branch dev e depois clique em "create fork"
Dentro do seu fork, garanta que você esteja no branch correto e faça o clone do repositório:
Faça as alterações necessárias nos fontes e faça commit para seu fork seguindo as diretrizes do primeiro item dessa página.
Após terminar de realizar todas as mudanças e testar para confirmar que esteja funcionando, basta fazer o Pull Request:
⚠ Importante lembrar que o seu PR precisa obrigatoriamente estar sincronizado com os últimos commits feitos no branch dev, PRs desatualizados serão automaticamente descartados.