guia contribuicao

Guia de contribuição do PascalRAL

Home > Guia de contribuição

Há quatro jeitos de ajudar.

1. Código

1. Leia o Padrão de Código.
2. Faça o fork e o Pull Request para o branch dev: passo a passo.
3. O código precisa compilar no Delphi e no Lazarus. Hoje essa conferência é manual: compile os pacotes nas duas IDEs antes de enviar. A verificação automática no PR está em desenvolvimento.
4. Teste o que mudou. O projeto tem uma bateria de testes própria (RALOrquestrador), que roda os motores, clientes e bancos entre si; os mantenedores a rodam antes de integrar.
5. A mensagem do commit vira nota de versão: veja Mensagem de commit.

2. Testes e relatos

• Achou um problema? Abra uma Issue com: versão do RAL, versão do Delphi/Lazarus, motor, a mensagem exata e, se possível, um projeto mínimo que reproduz.
• Quer discutir antes? Discord ou Telegram (links na Home).
• Fez teste de carga? Poste no grupo a metodologia, a máquina e os números.

3. Doação

OpenCollective do projeto.

4. Divulgação

Fez um vídeo, artigo ou curso? Avise no grupo de suporte; ele pode entrar em Vídeos e guias externos.

Documentação

A wiki aceita correções: aponte no grupo ou numa Issue o que está errado ou faltando.

Internos

Para quem mexe no código do RAL: por que cada parte é como é, as armadilhas de cada motor e as restrições que não aparecem na API. O código só traz a descrição curta de cada coisa (veja Documentação no código); a explicação longa mora aqui.

• Núcleo: servidor, cliente, pedido, resposta, parâmetros e rotas 🚧
• Plugins 🚧
• Motores 🚧
• Utilitários: stream, compressão, criptografia, JSON 🚧
• DBWare 🚧